From 53fb6d9971d37db15c98d5603b3d35feedbbe40e Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 22 Jun 2021 00:24:37 +0000 Subject: [PATCH 1/4] chore: remove all monolith Bazel deps chore: release gapic-generator-csharp v1.3.7 chore: release gapic-generator-go 0.20.5 chore: release gapic-generator-java 1.0.14 chore: release gapic-generator-php 1.0.1 chore: release gapic-generator-python 0.50.0 chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0 Committer: @miraleung PiperOrigin-RevId: 380641501 Source-Link: https://github.com/googleapis/googleapis/commit/076f7e9f0b258bdb54338895d7251b202e8f0de3 Source-Link: https://github.com/googleapis/googleapis-gen/commit/27e4c88b4048e5f56508d4e1aa417d60a3380892 --- owl-bot-staging/v1alpha/.coveragerc | 17 + owl-bot-staging/v1alpha/MANIFEST.in | 2 + owl-bot-staging/v1alpha/README.rst | 49 + owl-bot-staging/v1alpha/docs/conf.py | 376 +++ .../auto_suggestion_service.rst | 6 + .../docs/dataqna_v1alpha/question_service.rst | 6 + .../v1alpha/docs/dataqna_v1alpha/services.rst | 7 + .../v1alpha/docs/dataqna_v1alpha/types.rst | 7 + owl-bot-staging/v1alpha/docs/index.rst | 7 + .../v1alpha/google/cloud/dataqna/__init__.py | 71 + .../v1alpha/google/cloud/dataqna/py.typed | 2 + .../google/cloud/dataqna_v1alpha/__init__.py | 72 + .../cloud/dataqna_v1alpha/gapic_metadata.json | 97 + .../google/cloud/dataqna_v1alpha/py.typed | 2 + .../dataqna_v1alpha/services/__init__.py | 15 + .../auto_suggestion_service/__init__.py | 22 + .../auto_suggestion_service/async_client.py | 284 +++ .../auto_suggestion_service/client.py | 463 ++++ .../transports/__init__.py | 33 + .../transports/base.py | 168 ++ .../transports/grpc.py | 320 +++ .../transports/grpc_asyncio.py | 324 +++ .../services/question_service/__init__.py | 22 + .../services/question_service/async_client.py | 600 +++++ .../services/question_service/client.py | 796 ++++++ .../question_service/transports/__init__.py | 33 + .../question_service/transports/base.py | 228 ++ .../question_service/transports/grpc.py | 374 +++ .../transports/grpc_asyncio.py | 378 +++ .../cloud/dataqna_v1alpha/types/__init__.py | 72 + .../dataqna_v1alpha/types/annotated_string.py | 120 + .../types/auto_suggestion_service.py | 199 ++ .../cloud/dataqna_v1alpha/types/question.py | 593 +++++ .../dataqna_v1alpha/types/question_service.py | 138 ++ .../dataqna_v1alpha/types/user_feedback.py | 60 + owl-bot-staging/v1alpha/mypy.ini | 3 + owl-bot-staging/v1alpha/noxfile.py | 132 + .../scripts/fixup_dataqna_v1alpha_keywords.py | 181 ++ owl-bot-staging/v1alpha/setup.py | 53 + owl-bot-staging/v1alpha/tests/__init__.py | 16 + .../v1alpha/tests/unit/__init__.py | 16 + .../v1alpha/tests/unit/gapic/__init__.py | 16 + .../unit/gapic/dataqna_v1alpha/__init__.py | 16 + .../test_auto_suggestion_service.py | 1052 ++++++++ .../dataqna_v1alpha/test_question_service.py | 2197 +++++++++++++++++ 45 files changed, 9645 insertions(+) create mode 100644 owl-bot-staging/v1alpha/.coveragerc create mode 100644 owl-bot-staging/v1alpha/MANIFEST.in create mode 100644 owl-bot-staging/v1alpha/README.rst create mode 100644 owl-bot-staging/v1alpha/docs/conf.py create mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst create mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst create mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst create mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst create mode 100644 owl-bot-staging/v1alpha/docs/index.rst create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py create mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py create mode 100644 owl-bot-staging/v1alpha/mypy.ini create mode 100644 owl-bot-staging/v1alpha/noxfile.py create mode 100644 owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py create mode 100644 owl-bot-staging/v1alpha/setup.py create mode 100644 owl-bot-staging/v1alpha/tests/__init__.py create mode 100644 owl-bot-staging/v1alpha/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py create mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py create mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py diff --git a/owl-bot-staging/v1alpha/.coveragerc b/owl-bot-staging/v1alpha/.coveragerc new file mode 100644 index 0000000..017250b --- /dev/null +++ b/owl-bot-staging/v1alpha/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/dataqna/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1alpha/MANIFEST.in b/owl-bot-staging/v1alpha/MANIFEST.in new file mode 100644 index 0000000..cd6cbb6 --- /dev/null +++ b/owl-bot-staging/v1alpha/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/dataqna *.py +recursive-include google/cloud/dataqna_v1alpha *.py diff --git a/owl-bot-staging/v1alpha/README.rst b/owl-bot-staging/v1alpha/README.rst new file mode 100644 index 0000000..15fd204 --- /dev/null +++ b/owl-bot-staging/v1alpha/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Dataqna 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 Dataqna 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/v1alpha/docs/conf.py b/owl-bot-staging/v1alpha/docs/conf.py new file mode 100644 index 0000000..d0bbe40 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-dataqna documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "1.6.3" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-dataqna" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-dataqna-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "google-cloud-dataqna.tex", + u"google-cloud-dataqna Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "google-cloud-dataqna", + u"Google Cloud Dataqna Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "google-cloud-dataqna", + u"google-cloud-dataqna Documentation", + author, + "google-cloud-dataqna", + "GAPIC library for Google Cloud Dataqna 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/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst new file mode 100644 index 0000000..4a96dd5 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst @@ -0,0 +1,6 @@ +AutoSuggestionService +--------------------------------------- + +.. automodule:: google.cloud.dataqna_v1alpha.services.auto_suggestion_service + :members: + :inherited-members: diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst new file mode 100644 index 0000000..0c7fe89 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst @@ -0,0 +1,6 @@ +QuestionService +--------------------------------- + +.. automodule:: google.cloud.dataqna_v1alpha.services.question_service + :members: + :inherited-members: diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst new file mode 100644 index 0000000..00a6eb5 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Dataqna v1alpha API +============================================= +.. toctree:: + :maxdepth: 2 + + auto_suggestion_service + question_service diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst new file mode 100644 index 0000000..66f9ab9 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Dataqna v1alpha API +========================================== + +.. automodule:: google.cloud.dataqna_v1alpha.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1alpha/docs/index.rst b/owl-bot-staging/v1alpha/docs/index.rst new file mode 100644 index 0000000..f70fe42 --- /dev/null +++ b/owl-bot-staging/v1alpha/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + dataqna_v1alpha/services + dataqna_v1alpha/types diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py new file mode 100644 index 0000000..d1ce521 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.client import AutoSuggestionServiceClient +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.async_client import AutoSuggestionServiceAsyncClient +from google.cloud.dataqna_v1alpha.services.question_service.client import QuestionServiceClient +from google.cloud.dataqna_v1alpha.services.question_service.async_client import QuestionServiceAsyncClient + +from google.cloud.dataqna_v1alpha.types.annotated_string import AnnotatedString +from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import Suggestion +from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestionInfo +from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestQueriesRequest +from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestQueriesResponse +from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestionType +from google.cloud.dataqna_v1alpha.types.question import BigQueryJob +from google.cloud.dataqna_v1alpha.types.question import DataQuery +from google.cloud.dataqna_v1alpha.types.question import DebugFlags +from google.cloud.dataqna_v1alpha.types.question import ExecutionInfo +from google.cloud.dataqna_v1alpha.types.question import HumanReadable +from google.cloud.dataqna_v1alpha.types.question import Interpretation +from google.cloud.dataqna_v1alpha.types.question import InterpretationStructure +from google.cloud.dataqna_v1alpha.types.question import InterpretError +from google.cloud.dataqna_v1alpha.types.question import Question +from google.cloud.dataqna_v1alpha.types.question import InterpretEntity +from google.cloud.dataqna_v1alpha.types.question_service import CreateQuestionRequest +from google.cloud.dataqna_v1alpha.types.question_service import ExecuteQuestionRequest +from google.cloud.dataqna_v1alpha.types.question_service import GetQuestionRequest +from google.cloud.dataqna_v1alpha.types.question_service import GetUserFeedbackRequest +from google.cloud.dataqna_v1alpha.types.question_service import UpdateUserFeedbackRequest +from google.cloud.dataqna_v1alpha.types.user_feedback import UserFeedback + +__all__ = ('AutoSuggestionServiceClient', + 'AutoSuggestionServiceAsyncClient', + 'QuestionServiceClient', + 'QuestionServiceAsyncClient', + 'AnnotatedString', + 'Suggestion', + 'SuggestionInfo', + 'SuggestQueriesRequest', + 'SuggestQueriesResponse', + 'SuggestionType', + 'BigQueryJob', + 'DataQuery', + 'DebugFlags', + 'ExecutionInfo', + 'HumanReadable', + 'Interpretation', + 'InterpretationStructure', + 'InterpretError', + 'Question', + 'InterpretEntity', + 'CreateQuestionRequest', + 'ExecuteQuestionRequest', + 'GetQuestionRequest', + 'GetUserFeedbackRequest', + 'UpdateUserFeedbackRequest', + 'UserFeedback', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed b/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed new file mode 100644 index 0000000..305ad75 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-dataqna package uses inline types. diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py new file mode 100644 index 0000000..c29f2c5 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.auto_suggestion_service import AutoSuggestionServiceClient +from .services.auto_suggestion_service import AutoSuggestionServiceAsyncClient +from .services.question_service import QuestionServiceClient +from .services.question_service import QuestionServiceAsyncClient + +from .types.annotated_string import AnnotatedString +from .types.auto_suggestion_service import Suggestion +from .types.auto_suggestion_service import SuggestionInfo +from .types.auto_suggestion_service import SuggestQueriesRequest +from .types.auto_suggestion_service import SuggestQueriesResponse +from .types.auto_suggestion_service import SuggestionType +from .types.question import BigQueryJob +from .types.question import DataQuery +from .types.question import DebugFlags +from .types.question import ExecutionInfo +from .types.question import HumanReadable +from .types.question import Interpretation +from .types.question import InterpretationStructure +from .types.question import InterpretError +from .types.question import Question +from .types.question import InterpretEntity +from .types.question_service import CreateQuestionRequest +from .types.question_service import ExecuteQuestionRequest +from .types.question_service import GetQuestionRequest +from .types.question_service import GetUserFeedbackRequest +from .types.question_service import UpdateUserFeedbackRequest +from .types.user_feedback import UserFeedback + +__all__ = ( + 'AutoSuggestionServiceAsyncClient', + 'QuestionServiceAsyncClient', +'AnnotatedString', +'AutoSuggestionServiceClient', +'BigQueryJob', +'CreateQuestionRequest', +'DataQuery', +'DebugFlags', +'ExecuteQuestionRequest', +'ExecutionInfo', +'GetQuestionRequest', +'GetUserFeedbackRequest', +'HumanReadable', +'InterpretEntity', +'InterpretError', +'Interpretation', +'InterpretationStructure', +'Question', +'QuestionServiceClient', +'SuggestQueriesRequest', +'SuggestQueriesResponse', +'Suggestion', +'SuggestionInfo', +'SuggestionType', +'UpdateUserFeedbackRequest', +'UserFeedback', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json new file mode 100644 index 0000000..7ba1907 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json @@ -0,0 +1,97 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.dataqna_v1alpha", + "protoPackage": "google.cloud.dataqna.v1alpha", + "schema": "1.0", + "services": { + "AutoSuggestionService": { + "clients": { + "grpc": { + "libraryClient": "AutoSuggestionServiceClient", + "rpcs": { + "SuggestQueries": { + "methods": [ + "suggest_queries" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AutoSuggestionServiceAsyncClient", + "rpcs": { + "SuggestQueries": { + "methods": [ + "suggest_queries" + ] + } + } + } + } + }, + "QuestionService": { + "clients": { + "grpc": { + "libraryClient": "QuestionServiceClient", + "rpcs": { + "CreateQuestion": { + "methods": [ + "create_question" + ] + }, + "ExecuteQuestion": { + "methods": [ + "execute_question" + ] + }, + "GetQuestion": { + "methods": [ + "get_question" + ] + }, + "GetUserFeedback": { + "methods": [ + "get_user_feedback" + ] + }, + "UpdateUserFeedback": { + "methods": [ + "update_user_feedback" + ] + } + } + }, + "grpc-async": { + "libraryClient": "QuestionServiceAsyncClient", + "rpcs": { + "CreateQuestion": { + "methods": [ + "create_question" + ] + }, + "ExecuteQuestion": { + "methods": [ + "execute_question" + ] + }, + "GetQuestion": { + "methods": [ + "get_question" + ] + }, + "GetUserFeedback": { + "methods": [ + "get_user_feedback" + ] + }, + "UpdateUserFeedback": { + "methods": [ + "update_user_feedback" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed new file mode 100644 index 0000000..305ad75 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-dataqna package uses inline types. diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py new file mode 100644 index 0000000..eebfd7b --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import AutoSuggestionServiceClient +from .async_client import AutoSuggestionServiceAsyncClient + +__all__ = ( + 'AutoSuggestionServiceClient', + 'AutoSuggestionServiceAsyncClient', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py new file mode 100644 index 0000000..d9417e9 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py @@ -0,0 +1,284 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service +from .transports.base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport +from .client import AutoSuggestionServiceClient + + +class AutoSuggestionServiceAsyncClient: + """This stateless API provides automatic suggestions for natural + language queries for the data sources in the provided project and + location. + + The service provides a resourceless operation ``suggestQueries`` + that can be called to get a list of suggestions for a given + incomplete query and scope (or list of scopes) under which the query + is to be interpreted. + + There are two types of suggestions, ENTITY for single entity + suggestions and TEMPLATE for full sentences. By default, both types + are returned. + + Example Request: + + :: + + GetSuggestions({ + parent: "locations/us/projects/my-project" + scopes: + "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" + query: "top it" + }) + + The service will retrieve information based on the given scope(s) + and give suggestions based on that (e.g. "top item" for "top it" if + "item" is a known dimension for the provided scope). + + :: + + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "top item by sum of usd_revenue_net" + markups { + type: DIMENSION + start_char_index: 4 + length: 4 + } + markups { + type: METRIC + start_char_index: 19 + length: 15 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: TEMPLATE + ranking_score: 0.9 + } + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "item" + markups { + type: DIMENSION + start_char_index: 4 + length: 2 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: ENTITY + ranking_score: 0.8 + } + """ + + _client: AutoSuggestionServiceClient + + DEFAULT_ENDPOINT = AutoSuggestionServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AutoSuggestionServiceClient.DEFAULT_MTLS_ENDPOINT + + common_billing_account_path = staticmethod(AutoSuggestionServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(AutoSuggestionServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(AutoSuggestionServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(AutoSuggestionServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(AutoSuggestionServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(AutoSuggestionServiceClient.parse_common_organization_path) + common_project_path = staticmethod(AutoSuggestionServiceClient.common_project_path) + parse_common_project_path = staticmethod(AutoSuggestionServiceClient.parse_common_project_path) + common_location_path = staticmethod(AutoSuggestionServiceClient.common_location_path) + parse_common_location_path = staticmethod(AutoSuggestionServiceClient.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: + AutoSuggestionServiceAsyncClient: The constructed client. + """ + return AutoSuggestionServiceClient.from_service_account_info.__func__(AutoSuggestionServiceAsyncClient, 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: + AutoSuggestionServiceAsyncClient: The constructed client. + """ + return AutoSuggestionServiceClient.from_service_account_file.__func__(AutoSuggestionServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> AutoSuggestionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + AutoSuggestionServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(AutoSuggestionServiceClient).get_transport_class, type(AutoSuggestionServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, AutoSuggestionServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the auto suggestion 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, ~.AutoSuggestionServiceTransport]): 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 = AutoSuggestionServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def suggest_queries(self, + request: auto_suggestion_service.SuggestQueriesRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> auto_suggestion_service.SuggestQueriesResponse: + r"""Gets a list of suggestions based on a prefix string. + AutoSuggestion tolerance should be less than 1 second. + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.SuggestQueriesRequest`): + The request object. Request for query suggestions. + 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.dataqna_v1alpha.types.SuggestQueriesResponse: + Response to SuggestQueries. + """ + # Create or coerce a protobuf request object. + request = auto_suggestion_service.SuggestQueriesRequest(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.suggest_queries, + 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, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-dataqna", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "AutoSuggestionServiceAsyncClient", +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py new file mode 100644 index 0000000..a3be175 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py @@ -0,0 +1,463 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service +from .transports.base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import AutoSuggestionServiceGrpcTransport +from .transports.grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport + + +class AutoSuggestionServiceClientMeta(type): + """Metaclass for the AutoSuggestionService 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[AutoSuggestionServiceTransport]] + _transport_registry["grpc"] = AutoSuggestionServiceGrpcTransport + _transport_registry["grpc_asyncio"] = AutoSuggestionServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[AutoSuggestionServiceTransport]: + """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 AutoSuggestionServiceClient(metaclass=AutoSuggestionServiceClientMeta): + """This stateless API provides automatic suggestions for natural + language queries for the data sources in the provided project and + location. + + The service provides a resourceless operation ``suggestQueries`` + that can be called to get a list of suggestions for a given + incomplete query and scope (or list of scopes) under which the query + is to be interpreted. + + There are two types of suggestions, ENTITY for single entity + suggestions and TEMPLATE for full sentences. By default, both types + are returned. + + Example Request: + + :: + + GetSuggestions({ + parent: "locations/us/projects/my-project" + scopes: + "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" + query: "top it" + }) + + The service will retrieve information based on the given scope(s) + and give suggestions based on that (e.g. "top item" for "top it" if + "item" is a known dimension for the provided scope). + + :: + + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "top item by sum of usd_revenue_net" + markups { + type: DIMENSION + start_char_index: 4 + length: 4 + } + markups { + type: METRIC + start_char_index: 19 + length: 15 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: TEMPLATE + ranking_score: 0.9 + } + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "item" + markups { + type: DIMENSION + start_char_index: 4 + length: 2 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: ENTITY + ranking_score: 0.8 + } + """ + + @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 = "dataqna.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: + AutoSuggestionServiceClient: 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: + AutoSuggestionServiceClient: 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) -> AutoSuggestionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + AutoSuggestionServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, AutoSuggestionServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the auto suggestion 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, AutoSuggestionServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, AutoSuggestionServiceTransport): + # transport is a AutoSuggestionServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + ) + + def suggest_queries(self, + request: auto_suggestion_service.SuggestQueriesRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> auto_suggestion_service.SuggestQueriesResponse: + r"""Gets a list of suggestions based on a prefix string. + AutoSuggestion tolerance should be less than 1 second. + + Args: + request (google.cloud.dataqna_v1alpha.types.SuggestQueriesRequest): + The request object. Request for query suggestions. + 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.dataqna_v1alpha.types.SuggestQueriesResponse: + Response to SuggestQueries. + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a auto_suggestion_service.SuggestQueriesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, auto_suggestion_service.SuggestQueriesRequest): + request = auto_suggestion_service.SuggestQueriesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.suggest_queries] + + # 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-dataqna", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "AutoSuggestionServiceClient", +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py new file mode 100644 index 0000000..eebc1cb --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import AutoSuggestionServiceTransport +from .grpc import AutoSuggestionServiceGrpcTransport +from .grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[AutoSuggestionServiceTransport]] +_transport_registry['grpc'] = AutoSuggestionServiceGrpcTransport +_transport_registry['grpc_asyncio'] = AutoSuggestionServiceGrpcAsyncIOTransport + +__all__ = ( + 'AutoSuggestionServiceTransport', + 'AutoSuggestionServiceGrpcTransport', + 'AutoSuggestionServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py new file mode 100644 index 0000000..65b7eb0 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py @@ -0,0 +1,168 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-dataqna', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class AutoSuggestionServiceTransport(abc.ABC): + """Abstract transport class for AutoSuggestionService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'dataqna.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.suggest_queries: gapic_v1.method.wrap_method( + self.suggest_queries, + default_timeout=None, + client_info=client_info, + ), + } + + @property + def suggest_queries(self) -> Callable[ + [auto_suggestion_service.SuggestQueriesRequest], + Union[ + auto_suggestion_service.SuggestQueriesResponse, + Awaitable[auto_suggestion_service.SuggestQueriesResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'AutoSuggestionServiceTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py new file mode 100644 index 0000000..74846e6 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py @@ -0,0 +1,320 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service +from .base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO + + +class AutoSuggestionServiceGrpcTransport(AutoSuggestionServiceTransport): + """gRPC backend transport for AutoSuggestionService. + + This stateless API provides automatic suggestions for natural + language queries for the data sources in the provided project and + location. + + The service provides a resourceless operation ``suggestQueries`` + that can be called to get a list of suggestions for a given + incomplete query and scope (or list of scopes) under which the query + is to be interpreted. + + There are two types of suggestions, ENTITY for single entity + suggestions and TEMPLATE for full sentences. By default, both types + are returned. + + Example Request: + + :: + + GetSuggestions({ + parent: "locations/us/projects/my-project" + scopes: + "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" + query: "top it" + }) + + The service will retrieve information based on the given scope(s) + and give suggestions based on that (e.g. "top item" for "top it" if + "item" is a known dimension for the provided scope). + + :: + + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "top item by sum of usd_revenue_net" + markups { + type: DIMENSION + start_char_index: 4 + length: 4 + } + markups { + type: METRIC + start_char_index: 19 + length: 15 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: TEMPLATE + ranking_score: 0.9 + } + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "item" + markups { + type: DIMENSION + start_char_index: 4 + length: 2 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: ENTITY + ranking_score: 0.8 + } + + 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 = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def suggest_queries(self) -> Callable[ + [auto_suggestion_service.SuggestQueriesRequest], + auto_suggestion_service.SuggestQueriesResponse]: + r"""Return a callable for the suggest queries method over gRPC. + + Gets a list of suggestions based on a prefix string. + AutoSuggestion tolerance should be less than 1 second. + + Returns: + Callable[[~.SuggestQueriesRequest], + ~.SuggestQueriesResponse]: + 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 'suggest_queries' not in self._stubs: + self._stubs['suggest_queries'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.AutoSuggestionService/SuggestQueries', + request_serializer=auto_suggestion_service.SuggestQueriesRequest.serialize, + response_deserializer=auto_suggestion_service.SuggestQueriesResponse.deserialize, + ) + return self._stubs['suggest_queries'] + + +__all__ = ( + 'AutoSuggestionServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..c12c04d --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py @@ -0,0 +1,324 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service +from .base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import AutoSuggestionServiceGrpcTransport + + +class AutoSuggestionServiceGrpcAsyncIOTransport(AutoSuggestionServiceTransport): + """gRPC AsyncIO backend transport for AutoSuggestionService. + + This stateless API provides automatic suggestions for natural + language queries for the data sources in the provided project and + location. + + The service provides a resourceless operation ``suggestQueries`` + that can be called to get a list of suggestions for a given + incomplete query and scope (or list of scopes) under which the query + is to be interpreted. + + There are two types of suggestions, ENTITY for single entity + suggestions and TEMPLATE for full sentences. By default, both types + are returned. + + Example Request: + + :: + + GetSuggestions({ + parent: "locations/us/projects/my-project" + scopes: + "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" + query: "top it" + }) + + The service will retrieve information based on the given scope(s) + and give suggestions based on that (e.g. "top item" for "top it" if + "item" is a known dimension for the provided scope). + + :: + + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "top item by sum of usd_revenue_net" + markups { + type: DIMENSION + start_char_index: 4 + length: 4 + } + markups { + type: METRIC + start_char_index: 19 + length: 15 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: TEMPLATE + ranking_score: 0.9 + } + suggestions { + suggestion_info { + annotated_suggestion { + text_formatted: "item" + markups { + type: DIMENSION + start_char_index: 4 + length: 2 + } + } + query_matches { + start_char_index: 0 + length: 6 + } + } + suggestion_type: ENTITY + ranking_score: 0.8 + } + + 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 = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def suggest_queries(self) -> Callable[ + [auto_suggestion_service.SuggestQueriesRequest], + Awaitable[auto_suggestion_service.SuggestQueriesResponse]]: + r"""Return a callable for the suggest queries method over gRPC. + + Gets a list of suggestions based on a prefix string. + AutoSuggestion tolerance should be less than 1 second. + + Returns: + Callable[[~.SuggestQueriesRequest], + Awaitable[~.SuggestQueriesResponse]]: + 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 'suggest_queries' not in self._stubs: + self._stubs['suggest_queries'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.AutoSuggestionService/SuggestQueries', + request_serializer=auto_suggestion_service.SuggestQueriesRequest.serialize, + response_deserializer=auto_suggestion_service.SuggestQueriesResponse.deserialize, + ) + return self._stubs['suggest_queries'] + + +__all__ = ( + 'AutoSuggestionServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py new file mode 100644 index 0000000..6042509 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import QuestionServiceClient +from .async_client import QuestionServiceAsyncClient + +__all__ = ( + 'QuestionServiceClient', + 'QuestionServiceAsyncClient', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py new file mode 100644 index 0000000..cd81acc --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py @@ -0,0 +1,600 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import QuestionServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import QuestionServiceGrpcAsyncIOTransport +from .client import QuestionServiceClient + + +class QuestionServiceAsyncClient: + """Service to interpret natural language queries. The service allows to + create ``Question`` resources that are interpreted and are filled + with one or more interpretations if the question could be + interpreted. Once a ``Question`` resource is created and has at + least one interpretation, an interpretation can be chosen for + execution, which triggers a query to the backend (for BigQuery, it + will create a job). Upon successful execution of that + interpretation, backend specific information will be returned so + that the client can retrieve the results from the backend. + + The ``Question`` resources are named + ``projects/*/locations/*/questions/*``. + + The ``Question`` resource has a singletion sub-resource + ``UserFeedback`` named + ``projects/*/locations/*/questions/*/userFeedback``, which allows + access to user feedback. + """ + + _client: QuestionServiceClient + + DEFAULT_ENDPOINT = QuestionServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = QuestionServiceClient.DEFAULT_MTLS_ENDPOINT + + question_path = staticmethod(QuestionServiceClient.question_path) + parse_question_path = staticmethod(QuestionServiceClient.parse_question_path) + user_feedback_path = staticmethod(QuestionServiceClient.user_feedback_path) + parse_user_feedback_path = staticmethod(QuestionServiceClient.parse_user_feedback_path) + common_billing_account_path = staticmethod(QuestionServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(QuestionServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(QuestionServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(QuestionServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(QuestionServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(QuestionServiceClient.parse_common_organization_path) + common_project_path = staticmethod(QuestionServiceClient.common_project_path) + parse_common_project_path = staticmethod(QuestionServiceClient.parse_common_project_path) + common_location_path = staticmethod(QuestionServiceClient.common_location_path) + parse_common_location_path = staticmethod(QuestionServiceClient.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: + QuestionServiceAsyncClient: The constructed client. + """ + return QuestionServiceClient.from_service_account_info.__func__(QuestionServiceAsyncClient, 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: + QuestionServiceAsyncClient: The constructed client. + """ + return QuestionServiceClient.from_service_account_file.__func__(QuestionServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> QuestionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + QuestionServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(QuestionServiceClient).get_transport_class, type(QuestionServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, QuestionServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the question 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, ~.QuestionServiceTransport]): 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 = QuestionServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def get_question(self, + request: question_service.GetQuestionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> question.Question: + r"""Gets a previously created question. + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.GetQuestionRequest`): + The request object. A request to get a previously + created question. + name (:class:`str`): + Required. The unique identifier for the question. + Example: ``projects/foo/locations/bar/questions/1234`` + + 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = question_service.GetQuestionRequest(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_question, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_question(self, + request: question_service.CreateQuestionRequest = None, + *, + parent: str = None, + question: gcd_question.Question = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcd_question.Question: + r"""Creates a question. + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.CreateQuestionRequest`): + The request object. Request to create a question + resource. + parent (:class:`str`): + Required. The name of the project this data source + reference belongs to. Example: + ``projects/foo/locations/bar`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + question (:class:`google.cloud.dataqna_v1alpha.types.Question`): + Required. The question to create. + This corresponds to the ``question`` 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, question]) + 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 = question_service.CreateQuestionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if question is not None: + request.question = question + + # 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_question, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def execute_question(self, + request: question_service.ExecuteQuestionRequest = None, + *, + name: str = None, + interpretation_index: int = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> question.Question: + r"""Executes an interpretation. + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.ExecuteQuestionRequest`): + The request object. Request to execute an + interpretation. + name (:class:`str`): + Required. The unique identifier for the question. + Example: ``projects/foo/locations/bar/questions/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + interpretation_index (:class:`int`): + Required. Index of the interpretation + to execute. + + This corresponds to the ``interpretation_index`` 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, interpretation_index]) + 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 = question_service.ExecuteQuestionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if interpretation_index is not None: + request.interpretation_index = interpretation_index + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.execute_question, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_user_feedback(self, + request: question_service.GetUserFeedbackRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> user_feedback.UserFeedback: + r"""Gets previously created user feedback. + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.GetUserFeedbackRequest`): + The request object. Request to get user feedback. + name (:class:`str`): + Required. The unique identifier for the user feedback. + User feedback is a singleton resource on a Question. + Example: + ``projects/foo/locations/bar/questions/1234/userFeedback`` + + 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.dataqna_v1alpha.types.UserFeedback: + Feedback provided by a user. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = question_service.GetUserFeedbackRequest(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_user_feedback, + 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 update_user_feedback(self, + request: question_service.UpdateUserFeedbackRequest = None, + *, + user_feedback: gcd_user_feedback.UserFeedback = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcd_user_feedback.UserFeedback: + r"""Updates user feedback. This creates user feedback if + there was none before (upsert). + + Args: + request (:class:`google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest`): + The request object. Request to updates user feedback. + user_feedback (:class:`google.cloud.dataqna_v1alpha.types.UserFeedback`): + Required. The user feedback to + update. This can be called even if there + is no user feedback so far. The + feedback's name field is used to + identify the user feedback (and the + corresponding question) to update. + + This corresponds to the ``user_feedback`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + The list of fields to 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.dataqna_v1alpha.types.UserFeedback: + Feedback provided by a user. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([user_feedback, 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 = question_service.UpdateUserFeedbackRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if user_feedback is not None: + request.user_feedback = user_feedback + 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_user_feedback, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("user_feedback.name", request.user_feedback.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-dataqna", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "QuestionServiceAsyncClient", +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py new file mode 100644 index 0000000..babbbbd --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py @@ -0,0 +1,796 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import QuestionServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import QuestionServiceGrpcTransport +from .transports.grpc_asyncio import QuestionServiceGrpcAsyncIOTransport + + +class QuestionServiceClientMeta(type): + """Metaclass for the QuestionService 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[QuestionServiceTransport]] + _transport_registry["grpc"] = QuestionServiceGrpcTransport + _transport_registry["grpc_asyncio"] = QuestionServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[QuestionServiceTransport]: + """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 QuestionServiceClient(metaclass=QuestionServiceClientMeta): + """Service to interpret natural language queries. The service allows to + create ``Question`` resources that are interpreted and are filled + with one or more interpretations if the question could be + interpreted. Once a ``Question`` resource is created and has at + least one interpretation, an interpretation can be chosen for + execution, which triggers a query to the backend (for BigQuery, it + will create a job). Upon successful execution of that + interpretation, backend specific information will be returned so + that the client can retrieve the results from the backend. + + The ``Question`` resources are named + ``projects/*/locations/*/questions/*``. + + The ``Question`` resource has a singletion sub-resource + ``UserFeedback`` named + ``projects/*/locations/*/questions/*/userFeedback``, which allows + access to user feedback. + """ + + @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 = "dataqna.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: + QuestionServiceClient: 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: + QuestionServiceClient: 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) -> QuestionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + QuestionServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def question_path(project: str,location: str,question: str,) -> str: + """Returns a fully-qualified question string.""" + return "projects/{project}/locations/{location}/questions/{question}".format(project=project, location=location, question=question, ) + + @staticmethod + def parse_question_path(path: str) -> Dict[str,str]: + """Parses a question path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/questions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def user_feedback_path(project: str,location: str,question: str,) -> str: + """Returns a fully-qualified user_feedback string.""" + return "projects/{project}/locations/{location}/questions/{question}/userFeedback".format(project=project, location=location, question=question, ) + + @staticmethod + def parse_user_feedback_path(path: str) -> Dict[str,str]: + """Parses a user_feedback path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/questions/(?P.+?)/userFeedback$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, QuestionServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the question 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, QuestionServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, QuestionServiceTransport): + # transport is a QuestionServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + ) + + def get_question(self, + request: question_service.GetQuestionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> question.Question: + r"""Gets a previously created question. + + Args: + request (google.cloud.dataqna_v1alpha.types.GetQuestionRequest): + The request object. A request to get a previously + created question. + name (str): + Required. The unique identifier for the question. + Example: ``projects/foo/locations/bar/questions/1234`` + + 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a question_service.GetQuestionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, question_service.GetQuestionRequest): + request = question_service.GetQuestionRequest(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_question] + + # 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_question(self, + request: question_service.CreateQuestionRequest = None, + *, + parent: str = None, + question: gcd_question.Question = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcd_question.Question: + r"""Creates a question. + + Args: + request (google.cloud.dataqna_v1alpha.types.CreateQuestionRequest): + The request object. Request to create a question + resource. + parent (str): + Required. The name of the project this data source + reference belongs to. Example: + ``projects/foo/locations/bar`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + question (google.cloud.dataqna_v1alpha.types.Question): + Required. The question to create. + This corresponds to the ``question`` 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, question]) + 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 question_service.CreateQuestionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, question_service.CreateQuestionRequest): + request = question_service.CreateQuestionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if question is not None: + request.question = question + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_question] + + # 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 execute_question(self, + request: question_service.ExecuteQuestionRequest = None, + *, + name: str = None, + interpretation_index: int = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> question.Question: + r"""Executes an interpretation. + + Args: + request (google.cloud.dataqna_v1alpha.types.ExecuteQuestionRequest): + The request object. Request to execute an + interpretation. + name (str): + Required. The unique identifier for the question. + Example: ``projects/foo/locations/bar/questions/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + interpretation_index (int): + Required. Index of the interpretation + to execute. + + This corresponds to the ``interpretation_index`` 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.dataqna_v1alpha.types.Question: + The question resource represents a + natural language query, its settings, + understanding generated by the system, + and answer retrieval status. A question + cannot be modified. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, interpretation_index]) + 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 question_service.ExecuteQuestionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, question_service.ExecuteQuestionRequest): + request = question_service.ExecuteQuestionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if interpretation_index is not None: + request.interpretation_index = interpretation_index + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.execute_question] + + # 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_user_feedback(self, + request: question_service.GetUserFeedbackRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> user_feedback.UserFeedback: + r"""Gets previously created user feedback. + + Args: + request (google.cloud.dataqna_v1alpha.types.GetUserFeedbackRequest): + The request object. Request to get user feedback. + name (str): + Required. The unique identifier for the user feedback. + User feedback is a singleton resource on a Question. + Example: + ``projects/foo/locations/bar/questions/1234/userFeedback`` + + 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.dataqna_v1alpha.types.UserFeedback: + Feedback provided by a user. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a question_service.GetUserFeedbackRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, question_service.GetUserFeedbackRequest): + request = question_service.GetUserFeedbackRequest(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_user_feedback] + + # 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_user_feedback(self, + request: question_service.UpdateUserFeedbackRequest = None, + *, + user_feedback: gcd_user_feedback.UserFeedback = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcd_user_feedback.UserFeedback: + r"""Updates user feedback. This creates user feedback if + there was none before (upsert). + + Args: + request (google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest): + The request object. Request to updates user feedback. + user_feedback (google.cloud.dataqna_v1alpha.types.UserFeedback): + Required. The user feedback to + update. This can be called even if there + is no user feedback so far. The + feedback's name field is used to + identify the user feedback (and the + corresponding question) to update. + + This corresponds to the ``user_feedback`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to 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.dataqna_v1alpha.types.UserFeedback: + Feedback provided by a user. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([user_feedback, 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 question_service.UpdateUserFeedbackRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, question_service.UpdateUserFeedbackRequest): + request = question_service.UpdateUserFeedbackRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if user_feedback is not None: + request.user_feedback = user_feedback + 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_user_feedback] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("user_feedback.name", request.user_feedback.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-dataqna", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "QuestionServiceClient", +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py new file mode 100644 index 0000000..8e4e3ea --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import QuestionServiceTransport +from .grpc import QuestionServiceGrpcTransport +from .grpc_asyncio import QuestionServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[QuestionServiceTransport]] +_transport_registry['grpc'] = QuestionServiceGrpcTransport +_transport_registry['grpc_asyncio'] = QuestionServiceGrpcAsyncIOTransport + +__all__ = ( + 'QuestionServiceTransport', + 'QuestionServiceGrpcTransport', + 'QuestionServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py new file mode 100644 index 0000000..b33cc62 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py @@ -0,0 +1,228 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-dataqna', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class QuestionServiceTransport(abc.ABC): + """Abstract transport class for QuestionService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'dataqna.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.get_question: gapic_v1.method.wrap_method( + self.get_question, + default_timeout=None, + client_info=client_info, + ), + self.create_question: gapic_v1.method.wrap_method( + self.create_question, + default_timeout=60.0, + client_info=client_info, + ), + self.execute_question: gapic_v1.method.wrap_method( + self.execute_question, + default_timeout=60.0, + client_info=client_info, + ), + self.get_user_feedback: gapic_v1.method.wrap_method( + self.get_user_feedback, + default_timeout=None, + client_info=client_info, + ), + self.update_user_feedback: gapic_v1.method.wrap_method( + self.update_user_feedback, + default_timeout=60.0, + client_info=client_info, + ), + } + + @property + def get_question(self) -> Callable[ + [question_service.GetQuestionRequest], + Union[ + question.Question, + Awaitable[question.Question] + ]]: + raise NotImplementedError() + + @property + def create_question(self) -> Callable[ + [question_service.CreateQuestionRequest], + Union[ + gcd_question.Question, + Awaitable[gcd_question.Question] + ]]: + raise NotImplementedError() + + @property + def execute_question(self) -> Callable[ + [question_service.ExecuteQuestionRequest], + Union[ + question.Question, + Awaitable[question.Question] + ]]: + raise NotImplementedError() + + @property + def get_user_feedback(self) -> Callable[ + [question_service.GetUserFeedbackRequest], + Union[ + user_feedback.UserFeedback, + Awaitable[user_feedback.UserFeedback] + ]]: + raise NotImplementedError() + + @property + def update_user_feedback(self) -> Callable[ + [question_service.UpdateUserFeedbackRequest], + Union[ + gcd_user_feedback.UserFeedback, + Awaitable[gcd_user_feedback.UserFeedback] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'QuestionServiceTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py new file mode 100644 index 0000000..760bc88 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py @@ -0,0 +1,374 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from .base import QuestionServiceTransport, DEFAULT_CLIENT_INFO + + +class QuestionServiceGrpcTransport(QuestionServiceTransport): + """gRPC backend transport for QuestionService. + + Service to interpret natural language queries. The service allows to + create ``Question`` resources that are interpreted and are filled + with one or more interpretations if the question could be + interpreted. Once a ``Question`` resource is created and has at + least one interpretation, an interpretation can be chosen for + execution, which triggers a query to the backend (for BigQuery, it + will create a job). Upon successful execution of that + interpretation, backend specific information will be returned so + that the client can retrieve the results from the backend. + + The ``Question`` resources are named + ``projects/*/locations/*/questions/*``. + + The ``Question`` resource has a singletion sub-resource + ``UserFeedback`` named + ``projects/*/locations/*/questions/*/userFeedback``, which allows + access to user feedback. + + 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 = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def get_question(self) -> Callable[ + [question_service.GetQuestionRequest], + question.Question]: + r"""Return a callable for the get question method over gRPC. + + Gets a previously created question. + + Returns: + Callable[[~.GetQuestionRequest], + ~.Question]: + 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_question' not in self._stubs: + self._stubs['get_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/GetQuestion', + request_serializer=question_service.GetQuestionRequest.serialize, + response_deserializer=question.Question.deserialize, + ) + return self._stubs['get_question'] + + @property + def create_question(self) -> Callable[ + [question_service.CreateQuestionRequest], + gcd_question.Question]: + r"""Return a callable for the create question method over gRPC. + + Creates a question. + + Returns: + Callable[[~.CreateQuestionRequest], + ~.Question]: + 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_question' not in self._stubs: + self._stubs['create_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/CreateQuestion', + request_serializer=question_service.CreateQuestionRequest.serialize, + response_deserializer=gcd_question.Question.deserialize, + ) + return self._stubs['create_question'] + + @property + def execute_question(self) -> Callable[ + [question_service.ExecuteQuestionRequest], + question.Question]: + r"""Return a callable for the execute question method over gRPC. + + Executes an interpretation. + + Returns: + Callable[[~.ExecuteQuestionRequest], + ~.Question]: + 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 'execute_question' not in self._stubs: + self._stubs['execute_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/ExecuteQuestion', + request_serializer=question_service.ExecuteQuestionRequest.serialize, + response_deserializer=question.Question.deserialize, + ) + return self._stubs['execute_question'] + + @property + def get_user_feedback(self) -> Callable[ + [question_service.GetUserFeedbackRequest], + user_feedback.UserFeedback]: + r"""Return a callable for the get user feedback method over gRPC. + + Gets previously created user feedback. + + Returns: + Callable[[~.GetUserFeedbackRequest], + ~.UserFeedback]: + 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_user_feedback' not in self._stubs: + self._stubs['get_user_feedback'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/GetUserFeedback', + request_serializer=question_service.GetUserFeedbackRequest.serialize, + response_deserializer=user_feedback.UserFeedback.deserialize, + ) + return self._stubs['get_user_feedback'] + + @property + def update_user_feedback(self) -> Callable[ + [question_service.UpdateUserFeedbackRequest], + gcd_user_feedback.UserFeedback]: + r"""Return a callable for the update user feedback method over gRPC. + + Updates user feedback. This creates user feedback if + there was none before (upsert). + + Returns: + Callable[[~.UpdateUserFeedbackRequest], + ~.UserFeedback]: + 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_user_feedback' not in self._stubs: + self._stubs['update_user_feedback'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/UpdateUserFeedback', + request_serializer=question_service.UpdateUserFeedbackRequest.serialize, + response_deserializer=gcd_user_feedback.UserFeedback.deserialize, + ) + return self._stubs['update_user_feedback'] + + +__all__ = ( + 'QuestionServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..bc7174f --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py @@ -0,0 +1,378 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from .base import QuestionServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import QuestionServiceGrpcTransport + + +class QuestionServiceGrpcAsyncIOTransport(QuestionServiceTransport): + """gRPC AsyncIO backend transport for QuestionService. + + Service to interpret natural language queries. The service allows to + create ``Question`` resources that are interpreted and are filled + with one or more interpretations if the question could be + interpreted. Once a ``Question`` resource is created and has at + least one interpretation, an interpretation can be chosen for + execution, which triggers a query to the backend (for BigQuery, it + will create a job). Upon successful execution of that + interpretation, backend specific information will be returned so + that the client can retrieve the results from the backend. + + The ``Question`` resources are named + ``projects/*/locations/*/questions/*``. + + The ``Question`` resource has a singletion sub-resource + ``UserFeedback`` named + ``projects/*/locations/*/questions/*/userFeedback``, which allows + access to user feedback. + + 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 = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'dataqna.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def get_question(self) -> Callable[ + [question_service.GetQuestionRequest], + Awaitable[question.Question]]: + r"""Return a callable for the get question method over gRPC. + + Gets a previously created question. + + Returns: + Callable[[~.GetQuestionRequest], + Awaitable[~.Question]]: + 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_question' not in self._stubs: + self._stubs['get_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/GetQuestion', + request_serializer=question_service.GetQuestionRequest.serialize, + response_deserializer=question.Question.deserialize, + ) + return self._stubs['get_question'] + + @property + def create_question(self) -> Callable[ + [question_service.CreateQuestionRequest], + Awaitable[gcd_question.Question]]: + r"""Return a callable for the create question method over gRPC. + + Creates a question. + + Returns: + Callable[[~.CreateQuestionRequest], + Awaitable[~.Question]]: + 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_question' not in self._stubs: + self._stubs['create_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/CreateQuestion', + request_serializer=question_service.CreateQuestionRequest.serialize, + response_deserializer=gcd_question.Question.deserialize, + ) + return self._stubs['create_question'] + + @property + def execute_question(self) -> Callable[ + [question_service.ExecuteQuestionRequest], + Awaitable[question.Question]]: + r"""Return a callable for the execute question method over gRPC. + + Executes an interpretation. + + Returns: + Callable[[~.ExecuteQuestionRequest], + Awaitable[~.Question]]: + 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 'execute_question' not in self._stubs: + self._stubs['execute_question'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/ExecuteQuestion', + request_serializer=question_service.ExecuteQuestionRequest.serialize, + response_deserializer=question.Question.deserialize, + ) + return self._stubs['execute_question'] + + @property + def get_user_feedback(self) -> Callable[ + [question_service.GetUserFeedbackRequest], + Awaitable[user_feedback.UserFeedback]]: + r"""Return a callable for the get user feedback method over gRPC. + + Gets previously created user feedback. + + Returns: + Callable[[~.GetUserFeedbackRequest], + Awaitable[~.UserFeedback]]: + 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_user_feedback' not in self._stubs: + self._stubs['get_user_feedback'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/GetUserFeedback', + request_serializer=question_service.GetUserFeedbackRequest.serialize, + response_deserializer=user_feedback.UserFeedback.deserialize, + ) + return self._stubs['get_user_feedback'] + + @property + def update_user_feedback(self) -> Callable[ + [question_service.UpdateUserFeedbackRequest], + Awaitable[gcd_user_feedback.UserFeedback]]: + r"""Return a callable for the update user feedback method over gRPC. + + Updates user feedback. This creates user feedback if + there was none before (upsert). + + Returns: + Callable[[~.UpdateUserFeedbackRequest], + Awaitable[~.UserFeedback]]: + 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_user_feedback' not in self._stubs: + self._stubs['update_user_feedback'] = self.grpc_channel.unary_unary( + '/google.cloud.dataqna.v1alpha.QuestionService/UpdateUserFeedback', + request_serializer=question_service.UpdateUserFeedbackRequest.serialize, + response_deserializer=gcd_user_feedback.UserFeedback.deserialize, + ) + return self._stubs['update_user_feedback'] + + +__all__ = ( + 'QuestionServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py new file mode 100644 index 0000000..ee04af2 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .annotated_string import ( + AnnotatedString, +) +from .auto_suggestion_service import ( + Suggestion, + SuggestionInfo, + SuggestQueriesRequest, + SuggestQueriesResponse, + SuggestionType, +) +from .question import ( + BigQueryJob, + DataQuery, + DebugFlags, + ExecutionInfo, + HumanReadable, + Interpretation, + InterpretationStructure, + InterpretError, + Question, + InterpretEntity, +) +from .question_service import ( + CreateQuestionRequest, + ExecuteQuestionRequest, + GetQuestionRequest, + GetUserFeedbackRequest, + UpdateUserFeedbackRequest, +) +from .user_feedback import ( + UserFeedback, +) + +__all__ = ( + 'AnnotatedString', + 'Suggestion', + 'SuggestionInfo', + 'SuggestQueriesRequest', + 'SuggestQueriesResponse', + 'SuggestionType', + 'BigQueryJob', + 'DataQuery', + 'DebugFlags', + 'ExecutionInfo', + 'HumanReadable', + 'Interpretation', + 'InterpretationStructure', + 'InterpretError', + 'Question', + 'InterpretEntity', + 'CreateQuestionRequest', + 'ExecuteQuestionRequest', + 'GetQuestionRequest', + 'GetUserFeedbackRequest', + 'UpdateUserFeedbackRequest', + 'UserFeedback', +) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py new file mode 100644 index 0000000..b4d8378 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py @@ -0,0 +1,120 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.dataqna.v1alpha', + manifest={ + 'AnnotatedString', + }, +) + + +class AnnotatedString(proto.Message): + r"""Describes string annotation from both semantic and formatting + perspectives. Example: + + User Query: + + top countries by population in Africa + + 0 4 14 17 28 31 37 + + Table Data: + + - "country" - dimension + - "population" - metric + - "Africa" - value in the "continent" column + + text_formatted = ``"top countries by population in Africa"`` + + html_formatted = + ``"top countries by population in Africa"`` + + :: + + markups = [ + {DIMENSION, 4, 12}, // 'countries' + {METRIC, 17, 26}, // 'population' + {FILTER, 31, 36} // 'Africa' + ] + + Note that html formattings for 'DIMENSION' and 'METRIC' are the + same, while semantic markups are different. + + Attributes: + text_formatted (str): + Text version of the string. + html_formatted (str): + HTML version of the string annotation. + markups (Sequence[google.cloud.dataqna_v1alpha.types.AnnotatedString.SemanticMarkup]): + Semantic version of the string annotation. + """ + class SemanticMarkupType(proto.Enum): + r"""Semantic markup types.""" + MARKUP_TYPE_UNSPECIFIED = 0 + METRIC = 1 + DIMENSION = 2 + FILTER = 3 + UNUSED = 4 + BLOCKED = 5 + ROW = 6 + + class SemanticMarkup(proto.Message): + r"""Semantic markup denotes a substring (by index and length) + with markup information. + + Attributes: + type_ (google.cloud.dataqna_v1alpha.types.AnnotatedString.SemanticMarkupType): + The semantic type of the markup substring. + start_char_index (int): + Unicode character index of the query. + length (int): + The length (number of unicode characters) of + the markup substring. + """ + + type_ = proto.Field( + proto.ENUM, + number=1, + enum='AnnotatedString.SemanticMarkupType', + ) + start_char_index = proto.Field( + proto.INT32, + number=2, + ) + length = proto.Field( + proto.INT32, + number=3, + ) + + text_formatted = proto.Field( + proto.STRING, + number=1, + ) + html_formatted = proto.Field( + proto.STRING, + number=2, + ) + markups = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=SemanticMarkup, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py new file mode 100644 index 0000000..717efc5 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py @@ -0,0 +1,199 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.dataqna_v1alpha.types import annotated_string + + +__protobuf__ = proto.module( + package='google.cloud.dataqna.v1alpha', + manifest={ + 'SuggestionType', + 'SuggestQueriesRequest', + 'Suggestion', + 'SuggestionInfo', + 'SuggestQueriesResponse', + }, +) + + +class SuggestionType(proto.Enum): + r"""The type of suggestion.""" + SUGGESTION_TYPE_UNSPECIFIED = 0 + ENTITY = 1 + TEMPLATE = 2 + + +class SuggestQueriesRequest(proto.Message): + r"""Request for query suggestions. + Attributes: + parent (str): + Required. The parent of the suggestion query + is the resource denoting the project and + location. + scopes (Sequence[str]): + The scopes to which this search is restricted. The only + supported scope pattern is + ``//bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}``. + query (str): + User query for which to generate suggestions. + If the query is empty, zero state suggestions + are returned. This allows UIs to display + suggestions right away, helping the user to get + a sense of what a query might look like. + suggestion_types (Sequence[google.cloud.dataqna_v1alpha.types.SuggestionType]): + The requested suggestion type. Multiple + suggestion types can be requested, but there is + no guarantee that the service will return + suggestions for each type. Suggestions for a + requested type might rank lower than suggestions + for other types and the service may decide to + cut these suggestions off. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + scopes = proto.RepeatedField( + proto.STRING, + number=2, + ) + query = proto.Field( + proto.STRING, + number=3, + ) + suggestion_types = proto.RepeatedField( + proto.ENUM, + number=4, + enum='SuggestionType', + ) + + +class Suggestion(proto.Message): + r"""A suggestion for a query with a ranking score. + Attributes: + suggestion_info (google.cloud.dataqna_v1alpha.types.SuggestionInfo): + Detailed information about the suggestion. + ranking_score (float): + The score of the suggestion. This can be used to define + ordering in UI. The score represents confidence in the + suggestion where higher is better. All score values must be + in the range [0, 1). + suggestion_type (google.cloud.dataqna_v1alpha.types.SuggestionType): + The type of the suggestion. + """ + + suggestion_info = proto.Field( + proto.MESSAGE, + number=1, + message='SuggestionInfo', + ) + ranking_score = proto.Field( + proto.DOUBLE, + number=2, + ) + suggestion_type = proto.Field( + proto.ENUM, + number=3, + enum='SuggestionType', + ) + + +class SuggestionInfo(proto.Message): + r"""Detailed information about the suggestion. + Attributes: + annotated_suggestion (google.cloud.dataqna_v1alpha.types.AnnotatedString): + Annotations for the suggestion. This provides + information about which part of the suggestion + corresponds to what semantic meaning (e.g. a + metric). + query_matches (Sequence[google.cloud.dataqna_v1alpha.types.SuggestionInfo.MatchInfo]): + Matches between user query and the annotated + string. + """ + + class MatchInfo(proto.Message): + r"""MatchInfo describes which part of suggestion matched with data in + user typed query. This can be used to highlight matching parts in + the UI. This is different from the annotations provided in + annotated_suggestion. The annotated_suggestion provides information + about the semantic meaning, while this provides information about + how it relates to the input. + + Example: user query: ``top products`` + + :: + + annotated_suggestion { + text_formatted = "top product_group" + html_formatted = "top product_group" + markups { + {type: TEXT, start_char_index: 0, length: 3} + {type: DIMENSION, start_char_index: 4, length: 13} + } + } + + query_matches { + { start_char_index: 0, length: 3 } + { start_char_index: 4, length: 7} + } + + Attributes: + start_char_index (int): + Unicode character index of the string + annotation. + length (int): + Count of unicode characters of this + substring. + """ + + start_char_index = proto.Field( + proto.INT32, + number=1, + ) + length = proto.Field( + proto.INT32, + number=2, + ) + + annotated_suggestion = proto.Field( + proto.MESSAGE, + number=1, + message=annotated_string.AnnotatedString, + ) + query_matches = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=MatchInfo, + ) + + +class SuggestQueriesResponse(proto.Message): + r"""Response to SuggestQueries. + Attributes: + suggestions (Sequence[google.cloud.dataqna_v1alpha.types.Suggestion]): + A list of suggestions. + """ + + suggestions = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Suggestion', + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py new file mode 100644 index 0000000..4dd33be --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py @@ -0,0 +1,593 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.dataqna_v1alpha.types import annotated_string +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.dataqna.v1alpha', + manifest={ + 'InterpretEntity', + 'Question', + 'InterpretError', + 'ExecutionInfo', + 'BigQueryJob', + 'Interpretation', + 'DataQuery', + 'HumanReadable', + 'InterpretationStructure', + 'DebugFlags', + }, +) + + +class InterpretEntity(proto.Enum): + r"""Query entities of an interpretation.""" + INTERPRET_ENTITY_UNSPECIFIED = 0 + DIMENSION = 1 + METRIC = 2 + + +class Question(proto.Message): + r"""The question resource represents a natural language query, + its settings, understanding generated by the system, and answer + retrieval status. A question cannot be modified. + + Attributes: + name (str): + Output only. Immutable. The unique identifier for the + Question. The ID is server-generated. Example: + ``projects/foo/locations/bar/questions/123`` + scopes (Sequence[str]): + Required. Immutable. Scopes to be used for the question. A + scope defines the relevant data set scope. It can be a + reference to a specific data source or a collection of data + sources. Currently, support is limited to a single BigQuery + table. There must be exactly one ``scopes`` element. + + Example: + ``//bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar`` + query (str): + Required. Immutable. The query in natural + language. + data_source_annotations (Sequence[str]): + A list of annotations to use instead of the + default annotation of a data source (set in the + data source reference resource). There must not + be more than one annotation with the same data + source reference. + interpret_error (google.cloud.dataqna_v1alpha.types.InterpretError): + An error field explaining why interpretation + failed. This is only populated if the + interpretation failed. + Note: This is different from getting a status + error on the request itself. This is not a + client or server error and the Question resource + is still persisted, but the service could not + interpret the question. Clients should present + the error to the user so the user can rephrase + the question. + interpretations (Sequence[google.cloud.dataqna_v1alpha.types.Interpretation]): + A list of interpretations for this question. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the question was created. + user_email (str): + Output only. The e-mail address of the user + that created this question. + debug_flags (google.cloud.dataqna_v1alpha.types.DebugFlags): + Input only. Immutable. Flags to request + additional information for debugging purposes. + debug_info (google.protobuf.any_pb2.Any): + Top level debug information. + This will be stored as the type + DebugInformation. Using Any so clients don't + need to pull in anything inside the debug + message. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + scopes = proto.RepeatedField( + proto.STRING, + number=2, + ) + query = proto.Field( + proto.STRING, + number=3, + ) + data_source_annotations = proto.RepeatedField( + proto.STRING, + number=4, + ) + interpret_error = proto.Field( + proto.MESSAGE, + number=5, + message='InterpretError', + ) + interpretations = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='Interpretation', + ) + create_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + user_email = proto.Field( + proto.STRING, + number=8, + ) + debug_flags = proto.Field( + proto.MESSAGE, + number=9, + message='DebugFlags', + ) + debug_info = proto.Field( + proto.MESSAGE, + number=10, + message=any_pb2.Any, + ) + + +class InterpretError(proto.Message): + r"""Details on the failure to interpret the question. + Attributes: + message (str): + Error message explaining why this question + could not be interpreted. + code (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretErrorCode): + The code for the error category why the + interpretation failed. + details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretErrorDetails): + Details on interpretation failure. + """ + class InterpretErrorCode(proto.Enum): + r"""The interpret error code provides an error category why the + interpretation failed. + """ + INTERPRET_ERROR_CODE_UNSPECIFIED = 0 + INVALID_QUERY = 1 + FAILED_TO_UNDERSTAND = 2 + FAILED_TO_ANSWER = 3 + + class InterpretErrorDetails(proto.Message): + r"""Details on interpretation failure. + Attributes: + unsupported_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretUnsupportedDetails): + Populated if parts of the query are + unsupported. + incomplete_query_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretIncompleteQueryDetails): + Populated if the query is incomplete. + ambiguity_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretAmbiguityDetails): + Populated if the query was too ambiguous. + """ + + unsupported_details = proto.Field( + proto.MESSAGE, + number=1, + message='InterpretError.InterpretUnsupportedDetails', + ) + incomplete_query_details = proto.Field( + proto.MESSAGE, + number=2, + message='InterpretError.InterpretIncompleteQueryDetails', + ) + ambiguity_details = proto.Field( + proto.MESSAGE, + number=3, + message='InterpretError.InterpretAmbiguityDetails', + ) + + class InterpretUnsupportedDetails(proto.Message): + r"""Details about unsupported parts in a query. + Attributes: + operators (Sequence[str]): + Unsupported operators. For example: median. + intent (Sequence[str]): + Unsupported intents. + """ + + operators = proto.RepeatedField( + proto.STRING, + number=1, + ) + intent = proto.RepeatedField( + proto.STRING, + number=2, + ) + + class InterpretIncompleteQueryDetails(proto.Message): + r"""Details about an incomplete query. + Attributes: + entities (Sequence[google.cloud.dataqna_v1alpha.types.InterpretEntity]): + List of missing interpret entities. + """ + + entities = proto.RepeatedField( + proto.ENUM, + number=1, + enum='InterpretEntity', + ) + + class InterpretAmbiguityDetails(proto.Message): + r"""Details about a query that was too ambiguous. Currently, the + message has no fields and its presence signals that there was + ambiguity. + """ + + message = proto.Field( + proto.STRING, + number=1, + ) + code = proto.Field( + proto.ENUM, + number=2, + enum=InterpretErrorCode, + ) + details = proto.Field( + proto.MESSAGE, + number=3, + message=InterpretErrorDetails, + ) + + +class ExecutionInfo(proto.Message): + r"""Information about the backend status (such as BigQuery) of + the execution. + + Attributes: + job_creation_status (google.rpc.status_pb2.Status): + Status returned by the backend when the job + was created. + job_execution_state (google.cloud.dataqna_v1alpha.types.ExecutionInfo.JobExecutionState): + Status of the job execution. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the execution was triggered. + bigquery_job (google.cloud.dataqna_v1alpha.types.BigQueryJob): + BigQuery job information. + Future versions will have different backends. + Hence, clients must make sure they can handle it + when this field is not populated. + """ + class JobExecutionState(proto.Enum): + r"""Enum of possible job execution statuses.""" + JOB_EXECUTION_STATE_UNSPECIFIED = 0 + NOT_EXECUTED = 1 + RUNNING = 2 + SUCCEEDED = 3 + FAILED = 4 + + job_creation_status = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + job_execution_state = proto.Field( + proto.ENUM, + number=2, + enum=JobExecutionState, + ) + create_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + bigquery_job = proto.Field( + proto.MESSAGE, + number=4, + message='BigQueryJob', + ) + + +class BigQueryJob(proto.Message): + r"""BigQuery job information. This can be used to query the BigQuery API + and retrieve the current job's status (using + `jobs.get `__). + + Attributes: + job_id (str): + The job ID. + project_id (str): + The project ID of the job. + location (str): + The location where the job is running. + """ + + job_id = proto.Field( + proto.STRING, + number=1, + ) + project_id = proto.Field( + proto.STRING, + number=2, + ) + location = proto.Field( + proto.STRING, + number=3, + ) + + +class Interpretation(proto.Message): + r"""An interpretation of a natural language query. + Attributes: + data_sources (Sequence[str]): + List of data sources used in the current + understanding. + confidence (float): + The level of confidence that one of the interpretations is + correct. This is a value in the range [0, 1] where a value + of 0.5 or below is to be considered a low confidence. + unused_phrases (Sequence[str]): + A list of unused phrases. Clients should + display a Did You Mean (DYM) dialog if this is + non-empty, even if this is the only + interpretation. + human_readable (google.cloud.dataqna_v1alpha.types.HumanReadable): + Human readable representation of the query. + interpretation_structure (google.cloud.dataqna_v1alpha.types.InterpretationStructure): + Information about the interpretation + structure that helps to understand and visualize + the response. + data_query (google.cloud.dataqna_v1alpha.types.DataQuery): + Representation of the data query to be sent + to the backend. + execution_info (google.cloud.dataqna_v1alpha.types.ExecutionInfo): + Information about the backend response. This + is populated only if execution of an + interpretation was requested. + """ + + data_sources = proto.RepeatedField( + proto.STRING, + number=1, + ) + confidence = proto.Field( + proto.DOUBLE, + number=2, + ) + unused_phrases = proto.RepeatedField( + proto.STRING, + number=3, + ) + human_readable = proto.Field( + proto.MESSAGE, + number=4, + message='HumanReadable', + ) + interpretation_structure = proto.Field( + proto.MESSAGE, + number=5, + message='InterpretationStructure', + ) + data_query = proto.Field( + proto.MESSAGE, + number=6, + message='DataQuery', + ) + execution_info = proto.Field( + proto.MESSAGE, + number=7, + message='ExecutionInfo', + ) + + +class DataQuery(proto.Message): + r"""Representation of the data query for the backend. This is provided + for informational purposes only. Clients should not use it to send + it to the backend directly, but rather use the ``execute`` RPC to + trigger the execution. Using the ``execute`` RPC is needed in order + to track the state of a question and report on it correctly to the + data administrators. + + Attributes: + sql (str): + The generated SQL query to be sent to the + backend. + """ + + sql = proto.Field( + proto.STRING, + number=1, + ) + + +class HumanReadable(proto.Message): + r"""Human readable interpretation. + Attributes: + generated_interpretation (google.cloud.dataqna_v1alpha.types.AnnotatedString): + Generated query explaining the + interpretation. + original_question (google.cloud.dataqna_v1alpha.types.AnnotatedString): + Annotations on the original query. + """ + + generated_interpretation = proto.Field( + proto.MESSAGE, + number=1, + message=annotated_string.AnnotatedString, + ) + original_question = proto.Field( + proto.MESSAGE, + number=2, + message=annotated_string.AnnotatedString, + ) + + +class InterpretationStructure(proto.Message): + r"""Information about the interpretation structure that helps to + understand and visualize the response. + + Attributes: + visualization_types (Sequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.VisualizationType]): + List of possible visualization types to apply + for this interpretation. The order has no + relevance. + column_info (Sequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.ColumnInfo]): + Information about the output columns, that + is, the columns that will be returned by the + backend. + """ + class VisualizationType(proto.Enum): + r"""Enumeration of visualzation types to use for query response + data. + """ + VISUALIZATION_TYPE_UNSPECIFIED = 0 + TABLE = 1 + BAR_CHART = 2 + COLUMN_CHART = 3 + TIMELINE = 4 + SCATTER_PLOT = 5 + PIE_CHART = 6 + LINE_CHART = 7 + AREA_CHART = 8 + COMBO_CHART = 9 + HISTOGRAM = 10 + GENERIC_CHART = 11 + CHART_NOT_UNDERSTOOD = 12 + + class ColumnInfo(proto.Message): + r"""Information about a column. + Attributes: + output_alias (str): + The alias of the output column as used by the + backend. For example, the field name in the + schema provided in the query response in + BigQuery. + display_name (str): + Human readable name of the output column. + """ + + output_alias = proto.Field( + proto.STRING, + number=1, + ) + display_name = proto.Field( + proto.STRING, + number=2, + ) + + visualization_types = proto.RepeatedField( + proto.ENUM, + number=1, + enum=VisualizationType, + ) + column_info = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=ColumnInfo, + ) + + +class DebugFlags(proto.Message): + r"""Configuriation of debug flags. + Attributes: + include_va_query (bool): + Whether to include the original VAQuery. + include_nested_va_query (bool): + Whether to include the original nested + VAQuery. + include_human_interpretation (bool): + Whether to include the original human + interpretation strings generated by Analyza. + include_aqua_debug_response (bool): + Whether to include the Aqua debug response. + time_override (int): + The time in milliseconds from Unix epoch to be used to + process the query. This is useful for testing the queries at + different time period. If not set or time_override <= 0, + then the current time is used. + is_internal_google_user (bool): + Set to true if request is initiated by an + internal Google user. + ignore_cache (bool): + Determines whether cache needs to be ignored. + If set to true, cache won't be queried and + updated. + include_search_entities_rpc (bool): + Whether to include the request/response pair + from the call to the EntityIndex for + SearchEntities. + include_list_column_annotations_rpc (bool): + Whether to include the request/response pair + from the call to the Annotations service for + ListColumnAnnotations. + include_virtual_analyst_entities (bool): + Whether to include the entity list passed to + Analyza. + include_table_list (bool): + Whether to include the table list. + include_domain_list (bool): + Whether to include the domain list. + """ + + include_va_query = proto.Field( + proto.BOOL, + number=1, + ) + include_nested_va_query = proto.Field( + proto.BOOL, + number=2, + ) + include_human_interpretation = proto.Field( + proto.BOOL, + number=3, + ) + include_aqua_debug_response = proto.Field( + proto.BOOL, + number=4, + ) + time_override = proto.Field( + proto.INT64, + number=5, + ) + is_internal_google_user = proto.Field( + proto.BOOL, + number=6, + ) + ignore_cache = proto.Field( + proto.BOOL, + number=7, + ) + include_search_entities_rpc = proto.Field( + proto.BOOL, + number=8, + ) + include_list_column_annotations_rpc = proto.Field( + proto.BOOL, + number=9, + ) + include_virtual_analyst_entities = proto.Field( + proto.BOOL, + number=10, + ) + include_table_list = proto.Field( + proto.BOOL, + number=11, + ) + include_domain_list = proto.Field( + proto.BOOL, + number=12, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py new file mode 100644 index 0000000..b558a44 --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py @@ -0,0 +1,138 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.dataqna.v1alpha', + manifest={ + 'GetQuestionRequest', + 'CreateQuestionRequest', + 'ExecuteQuestionRequest', + 'GetUserFeedbackRequest', + 'UpdateUserFeedbackRequest', + }, +) + + +class GetQuestionRequest(proto.Message): + r"""A request to get a previously created question. + Attributes: + name (str): + Required. The unique identifier for the question. Example: + ``projects/foo/locations/bar/questions/1234`` + read_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be retrieved. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class CreateQuestionRequest(proto.Message): + r"""Request to create a question resource. + Attributes: + parent (str): + Required. The name of the project this data source reference + belongs to. Example: ``projects/foo/locations/bar`` + question (google.cloud.dataqna_v1alpha.types.Question): + Required. The question to create. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + question = proto.Field( + proto.MESSAGE, + number=2, + message=gcd_question.Question, + ) + + +class ExecuteQuestionRequest(proto.Message): + r"""Request to execute an interpretation. + Attributes: + name (str): + Required. The unique identifier for the question. Example: + ``projects/foo/locations/bar/questions/1234`` + interpretation_index (int): + Required. Index of the interpretation to + execute. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + interpretation_index = proto.Field( + proto.INT32, + number=2, + ) + + +class GetUserFeedbackRequest(proto.Message): + r"""Request to get user feedback. + Attributes: + name (str): + Required. The unique identifier for the user feedback. User + feedback is a singleton resource on a Question. Example: + ``projects/foo/locations/bar/questions/1234/userFeedback`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateUserFeedbackRequest(proto.Message): + r"""Request to updates user feedback. + Attributes: + user_feedback (google.cloud.dataqna_v1alpha.types.UserFeedback): + Required. The user feedback to update. This + can be called even if there is no user feedback + so far. The feedback's name field is used to + identify the user feedback (and the + corresponding question) to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + user_feedback = proto.Field( + proto.MESSAGE, + number=1, + message=gcd_user_feedback.UserFeedback, + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py new file mode 100644 index 0000000..c77abcf --- /dev/null +++ b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.dataqna.v1alpha', + manifest={ + 'UserFeedback', + }, +) + + +class UserFeedback(proto.Message): + r"""Feedback provided by a user. + Attributes: + name (str): + Required. The unique identifier for the user feedback. User + feedback is a singleton resource on a Question. Example: + ``projects/foo/locations/bar/questions/1234/userFeedback`` + free_form_feedback (str): + Free form user feedback, such as a text box. + rating (google.cloud.dataqna_v1alpha.types.UserFeedback.UserFeedbackRating): + The user feedback rating + """ + class UserFeedbackRating(proto.Enum): + r"""Enumeration of feedback ratings.""" + USER_FEEDBACK_RATING_UNSPECIFIED = 0 + POSITIVE = 1 + NEGATIVE = 2 + + name = proto.Field( + proto.STRING, + number=1, + ) + free_form_feedback = proto.Field( + proto.STRING, + number=2, + ) + rating = proto.Field( + proto.ENUM, + number=3, + enum=UserFeedbackRating, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/mypy.ini b/owl-bot-staging/v1alpha/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1alpha/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1alpha/noxfile.py b/owl-bot-staging/v1alpha/noxfile.py new file mode 100644 index 0000000..8d47afa --- /dev/null +++ b/owl-bot-staging/v1alpha/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/dataqna_v1alpha/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py b/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py new file mode 100644 index 0000000..da5349a --- /dev/null +++ b/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py @@ -0,0 +1,181 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class dataqnaCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_question': ('parent', 'question', ), + 'execute_question': ('name', 'interpretation_index', ), + 'get_question': ('name', 'read_mask', ), + 'get_user_feedback': ('name', ), + 'suggest_queries': ('parent', 'scopes', 'query', 'suggestion_types', ), + 'update_user_feedback': ('user_feedback', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: not a.keyword.value in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=dataqnaCallTransformer(), +): + """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 dataqna 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/v1alpha/setup.py b/owl-bot-staging/v1alpha/setup.py new file mode 100644 index 0000000..1d7e204 --- /dev/null +++ b/owl-bot-staging/v1alpha/setup.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-dataqna', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1alpha/tests/__init__.py b/owl-bot-staging/v1alpha/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1alpha/tests/unit/__init__.py b/owl-bot-staging/v1alpha/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py b/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py new file mode 100644 index 0000000..4dd158b --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py @@ -0,0 +1,1052 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import AutoSuggestionServiceAsyncClient +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import AutoSuggestionServiceClient +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import transports +from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.dataqna_v1alpha.types import auto_suggestion_service +from google.oauth2 import service_account +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(None) is None + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert AutoSuggestionServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + AutoSuggestionServiceClient, + AutoSuggestionServiceAsyncClient, +]) +def test_auto_suggestion_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'dataqna.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + AutoSuggestionServiceClient, + AutoSuggestionServiceAsyncClient, +]) +def test_auto_suggestion_service_client_service_account_always_use_jwt(client_class): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + +@pytest.mark.parametrize("client_class", [ + AutoSuggestionServiceClient, + AutoSuggestionServiceAsyncClient, +]) +def test_auto_suggestion_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'dataqna.googleapis.com:443' + + +def test_auto_suggestion_service_client_get_transport_class(): + transport = AutoSuggestionServiceClient.get_transport_class() + available_transports = [ + transports.AutoSuggestionServiceGrpcTransport, + ] + assert transport in available_transports + + transport = AutoSuggestionServiceClient.get_transport_class("grpc") + assert transport == transports.AutoSuggestionServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), + (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(AutoSuggestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceClient)) +@mock.patch.object(AutoSuggestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceAsyncClient)) +def test_auto_suggestion_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(AutoSuggestionServiceClient, '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(AutoSuggestionServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc", "true"), + (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc", "false"), + (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(AutoSuggestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceClient)) +@mock.patch.object(AutoSuggestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_auto_suggestion_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), + (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_auto_suggestion_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), + (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_auto_suggestion_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +def test_auto_suggestion_service_client_client_options_from_dict(): + with mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = AutoSuggestionServiceClient( + 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, + ) + + +def test_suggest_queries(transport: str = 'grpc', request_type=auto_suggestion_service.SuggestQueriesRequest): + client = AutoSuggestionServiceClient( + 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.suggest_queries), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = auto_suggestion_service.SuggestQueriesResponse( + ) + response = client.suggest_queries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == auto_suggestion_service.SuggestQueriesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, auto_suggestion_service.SuggestQueriesResponse) + + +def test_suggest_queries_from_dict(): + test_suggest_queries(request_type=dict) + + +def test_suggest_queries_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 = AutoSuggestionServiceClient( + 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.suggest_queries), + '__call__') as call: + client.suggest_queries() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == auto_suggestion_service.SuggestQueriesRequest() + + +@pytest.mark.asyncio +async def test_suggest_queries_async(transport: str = 'grpc_asyncio', request_type=auto_suggestion_service.SuggestQueriesRequest): + client = AutoSuggestionServiceAsyncClient( + 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.suggest_queries), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(auto_suggestion_service.SuggestQueriesResponse( + )) + response = await client.suggest_queries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == auto_suggestion_service.SuggestQueriesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, auto_suggestion_service.SuggestQueriesResponse) + + +@pytest.mark.asyncio +async def test_suggest_queries_async_from_dict(): + await test_suggest_queries_async(request_type=dict) + + +def test_suggest_queries_field_headers(): + client = AutoSuggestionServiceClient( + 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 = auto_suggestion_service.SuggestQueriesRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.suggest_queries), + '__call__') as call: + call.return_value = auto_suggestion_service.SuggestQueriesResponse() + client.suggest_queries(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_suggest_queries_field_headers_async(): + client = AutoSuggestionServiceAsyncClient( + 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 = auto_suggestion_service.SuggestQueriesRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.suggest_queries), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(auto_suggestion_service.SuggestQueriesResponse()) + await client.suggest_queries(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_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AutoSuggestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AutoSuggestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AutoSuggestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AutoSuggestionServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AutoSuggestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AutoSuggestionServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AutoSuggestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AutoSuggestionServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AutoSuggestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AutoSuggestionServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.AutoSuggestionServiceGrpcTransport, + transports.AutoSuggestionServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AutoSuggestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AutoSuggestionServiceGrpcTransport, + ) + +def test_auto_suggestion_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AutoSuggestionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_auto_suggestion_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.AutoSuggestionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'suggest_queries', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_auto_suggestion_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.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AutoSuggestionServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_auto_suggestion_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AutoSuggestionServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_auto_suggestion_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.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AutoSuggestionServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_auto_suggestion_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) + AutoSuggestionServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_auto_suggestion_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + AutoSuggestionServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AutoSuggestionServiceGrpcTransport, + transports.AutoSuggestionServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_auto_suggestion_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.AutoSuggestionServiceGrpcTransport, + transports.AutoSuggestionServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_auto_suggestion_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AutoSuggestionServiceGrpcTransport, grpc_helpers), + (transports.AutoSuggestionServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_auto_suggestion_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( + "dataqna.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="dataqna.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) +def test_auto_suggestion_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_auto_suggestion_service_host_no_port(): + client = AutoSuggestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com'), + ) + assert client.transport._host == 'dataqna.googleapis.com:443' + + +def test_auto_suggestion_service_host_with_port(): + client = AutoSuggestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com:8000'), + ) + assert client.transport._host == 'dataqna.googleapis.com:8000' + +def test_auto_suggestion_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AutoSuggestionServiceGrpcTransport( + 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_auto_suggestion_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AutoSuggestionServiceGrpcAsyncIOTransport( + 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.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) +def test_auto_suggestion_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) +def test_auto_suggestion_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = AutoSuggestionServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = AutoSuggestionServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AutoSuggestionServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = AutoSuggestionServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = AutoSuggestionServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AutoSuggestionServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = AutoSuggestionServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = AutoSuggestionServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AutoSuggestionServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = AutoSuggestionServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = AutoSuggestionServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AutoSuggestionServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = AutoSuggestionServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = AutoSuggestionServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AutoSuggestionServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.AutoSuggestionServiceTransport, '_prep_wrapped_messages') as prep: + client = AutoSuggestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.AutoSuggestionServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = AutoSuggestionServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py new file mode 100644 index 0000000..4553677 --- /dev/null +++ b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py @@ -0,0 +1,2197 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.dataqna_v1alpha.services.question_service import QuestionServiceAsyncClient +from google.cloud.dataqna_v1alpha.services.question_service import QuestionServiceClient +from google.cloud.dataqna_v1alpha.services.question_service import transports +from google.cloud.dataqna_v1alpha.services.question_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.dataqna_v1alpha.types import annotated_string +from google.cloud.dataqna_v1alpha.types import question +from google.cloud.dataqna_v1alpha.types import question as gcd_question +from google.cloud.dataqna_v1alpha.types import question_service +from google.cloud.dataqna_v1alpha.types import user_feedback +from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback +from google.oauth2 import service_account +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert QuestionServiceClient._get_default_mtls_endpoint(None) is None + assert QuestionServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert QuestionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert QuestionServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert QuestionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert QuestionServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + QuestionServiceClient, + QuestionServiceAsyncClient, +]) +def test_question_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'dataqna.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + QuestionServiceClient, + QuestionServiceAsyncClient, +]) +def test_question_service_client_service_account_always_use_jwt(client_class): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + +@pytest.mark.parametrize("client_class", [ + QuestionServiceClient, + QuestionServiceAsyncClient, +]) +def test_question_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'dataqna.googleapis.com:443' + + +def test_question_service_client_get_transport_class(): + transport = QuestionServiceClient.get_transport_class() + available_transports = [ + transports.QuestionServiceGrpcTransport, + ] + assert transport in available_transports + + transport = QuestionServiceClient.get_transport_class("grpc") + assert transport == transports.QuestionServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), + (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(QuestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceClient)) +@mock.patch.object(QuestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceAsyncClient)) +def test_question_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(QuestionServiceClient, '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(QuestionServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc", "true"), + (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc", "false"), + (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(QuestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceClient)) +@mock.patch.object(QuestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_question_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), + (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_question_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), + (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_question_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +def test_question_service_client_client_options_from_dict(): + with mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = QuestionServiceClient( + 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, + ) + + +def test_get_question(transport: str = 'grpc', request_type=question_service.GetQuestionRequest): + client = QuestionServiceClient( + 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_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + ) + response = client.get_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +def test_get_question_from_dict(): + test_get_question(request_type=dict) + + +def test_get_question_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 = QuestionServiceClient( + 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_question), + '__call__') as call: + client.get_question() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetQuestionRequest() + + +@pytest.mark.asyncio +async def test_get_question_async(transport: str = 'grpc_asyncio', request_type=question_service.GetQuestionRequest): + client = QuestionServiceAsyncClient( + 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_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + )) + response = await client.get_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +@pytest.mark.asyncio +async def test_get_question_async_from_dict(): + await test_get_question_async(request_type=dict) + + +def test_get_question_field_headers(): + client = QuestionServiceClient( + 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 = question_service.GetQuestionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_question), + '__call__') as call: + call.return_value = question.Question() + client.get_question(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_question_field_headers_async(): + client = QuestionServiceAsyncClient( + 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 = question_service.GetQuestionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_question), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) + await client.get_question(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_question_flattened(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_question( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_question_flattened_error(): + client = QuestionServiceClient( + 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_question( + question_service.GetQuestionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_question_flattened_async(): + client = QuestionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_question( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_question_flattened_error_async(): + client = QuestionServiceAsyncClient( + 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_question( + question_service.GetQuestionRequest(), + name='name_value', + ) + + +def test_create_question(transport: str = 'grpc', request_type=question_service.CreateQuestionRequest): + client = QuestionServiceClient( + 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_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + ) + response = client.create_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.CreateQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcd_question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +def test_create_question_from_dict(): + test_create_question(request_type=dict) + + +def test_create_question_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 = QuestionServiceClient( + 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_question), + '__call__') as call: + client.create_question() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.CreateQuestionRequest() + + +@pytest.mark.asyncio +async def test_create_question_async(transport: str = 'grpc_asyncio', request_type=question_service.CreateQuestionRequest): + client = QuestionServiceAsyncClient( + 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_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + )) + response = await client.create_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.CreateQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcd_question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +@pytest.mark.asyncio +async def test_create_question_async_from_dict(): + await test_create_question_async(request_type=dict) + + +def test_create_question_field_headers(): + client = QuestionServiceClient( + 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 = question_service.CreateQuestionRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_question), + '__call__') as call: + call.return_value = gcd_question.Question() + client.create_question(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_question_field_headers_async(): + client = QuestionServiceAsyncClient( + 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 = question_service.CreateQuestionRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_question), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question()) + await client.create_question(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_question_flattened(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_question.Question() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_question( + parent='parent_value', + question=gcd_question.Question(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].question == gcd_question.Question(name='name_value') + + +def test_create_question_flattened_error(): + client = QuestionServiceClient( + 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_question( + question_service.CreateQuestionRequest(), + parent='parent_value', + question=gcd_question.Question(name='name_value'), + ) + + +@pytest.mark.asyncio +async def test_create_question_flattened_async(): + client = QuestionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_question.Question() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_question( + parent='parent_value', + question=gcd_question.Question(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].question == gcd_question.Question(name='name_value') + + +@pytest.mark.asyncio +async def test_create_question_flattened_error_async(): + client = QuestionServiceAsyncClient( + 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_question( + question_service.CreateQuestionRequest(), + parent='parent_value', + question=gcd_question.Question(name='name_value'), + ) + + +def test_execute_question(transport: str = 'grpc', request_type=question_service.ExecuteQuestionRequest): + client = QuestionServiceClient( + 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.execute_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + ) + response = client.execute_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.ExecuteQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +def test_execute_question_from_dict(): + test_execute_question(request_type=dict) + + +def test_execute_question_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 = QuestionServiceClient( + 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.execute_question), + '__call__') as call: + client.execute_question() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.ExecuteQuestionRequest() + + +@pytest.mark.asyncio +async def test_execute_question_async(transport: str = 'grpc_asyncio', request_type=question_service.ExecuteQuestionRequest): + client = QuestionServiceAsyncClient( + 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.execute_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(question.Question( + name='name_value', + scopes=['scopes_value'], + query='query_value', + data_source_annotations=['data_source_annotations_value'], + user_email='user_email_value', + )) + response = await client.execute_question(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.ExecuteQuestionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, question.Question) + assert response.name == 'name_value' + assert response.scopes == ['scopes_value'] + assert response.query == 'query_value' + assert response.data_source_annotations == ['data_source_annotations_value'] + assert response.user_email == 'user_email_value' + + +@pytest.mark.asyncio +async def test_execute_question_async_from_dict(): + await test_execute_question_async(request_type=dict) + + +def test_execute_question_field_headers(): + client = QuestionServiceClient( + 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 = question_service.ExecuteQuestionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.execute_question), + '__call__') as call: + call.return_value = question.Question() + client.execute_question(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_execute_question_field_headers_async(): + client = QuestionServiceAsyncClient( + 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 = question_service.ExecuteQuestionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.execute_question), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) + await client.execute_question(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_execute_question_flattened(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.execute_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.execute_question( + name='name_value', + interpretation_index=2159, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].interpretation_index == 2159 + + +def test_execute_question_flattened_error(): + client = QuestionServiceClient( + 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.execute_question( + question_service.ExecuteQuestionRequest(), + name='name_value', + interpretation_index=2159, + ) + + +@pytest.mark.asyncio +async def test_execute_question_flattened_async(): + client = QuestionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.execute_question), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = question.Question() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.execute_question( + name='name_value', + interpretation_index=2159, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].interpretation_index == 2159 + + +@pytest.mark.asyncio +async def test_execute_question_flattened_error_async(): + client = QuestionServiceAsyncClient( + 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.execute_question( + question_service.ExecuteQuestionRequest(), + name='name_value', + interpretation_index=2159, + ) + + +def test_get_user_feedback(transport: str = 'grpc', request_type=question_service.GetUserFeedbackRequest): + client = QuestionServiceClient( + 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_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = user_feedback.UserFeedback( + name='name_value', + free_form_feedback='free_form_feedback_value', + rating=user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, + ) + response = client.get_user_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetUserFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, user_feedback.UserFeedback) + assert response.name == 'name_value' + assert response.free_form_feedback == 'free_form_feedback_value' + assert response.rating == user_feedback.UserFeedback.UserFeedbackRating.POSITIVE + + +def test_get_user_feedback_from_dict(): + test_get_user_feedback(request_type=dict) + + +def test_get_user_feedback_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 = QuestionServiceClient( + 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_user_feedback), + '__call__') as call: + client.get_user_feedback() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetUserFeedbackRequest() + + +@pytest.mark.asyncio +async def test_get_user_feedback_async(transport: str = 'grpc_asyncio', request_type=question_service.GetUserFeedbackRequest): + client = QuestionServiceAsyncClient( + 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_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback( + name='name_value', + free_form_feedback='free_form_feedback_value', + rating=user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, + )) + response = await client.get_user_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.GetUserFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, user_feedback.UserFeedback) + assert response.name == 'name_value' + assert response.free_form_feedback == 'free_form_feedback_value' + assert response.rating == user_feedback.UserFeedback.UserFeedbackRating.POSITIVE + + +@pytest.mark.asyncio +async def test_get_user_feedback_async_from_dict(): + await test_get_user_feedback_async(request_type=dict) + + +def test_get_user_feedback_field_headers(): + client = QuestionServiceClient( + 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 = question_service.GetUserFeedbackRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_user_feedback), + '__call__') as call: + call.return_value = user_feedback.UserFeedback() + client.get_user_feedback(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_user_feedback_field_headers_async(): + client = QuestionServiceAsyncClient( + 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 = question_service.GetUserFeedbackRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_user_feedback), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback()) + await client.get_user_feedback(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_user_feedback_flattened(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = user_feedback.UserFeedback() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_user_feedback( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_user_feedback_flattened_error(): + client = QuestionServiceClient( + 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_user_feedback( + question_service.GetUserFeedbackRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_user_feedback_flattened_async(): + client = QuestionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = user_feedback.UserFeedback() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_user_feedback( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_user_feedback_flattened_error_async(): + client = QuestionServiceAsyncClient( + 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_user_feedback( + question_service.GetUserFeedbackRequest(), + name='name_value', + ) + + +def test_update_user_feedback(transport: str = 'grpc', request_type=question_service.UpdateUserFeedbackRequest): + client = QuestionServiceClient( + 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_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_user_feedback.UserFeedback( + name='name_value', + free_form_feedback='free_form_feedback_value', + rating=gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, + ) + response = client.update_user_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.UpdateUserFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcd_user_feedback.UserFeedback) + assert response.name == 'name_value' + assert response.free_form_feedback == 'free_form_feedback_value' + assert response.rating == gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE + + +def test_update_user_feedback_from_dict(): + test_update_user_feedback(request_type=dict) + + +def test_update_user_feedback_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 = QuestionServiceClient( + 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_user_feedback), + '__call__') as call: + client.update_user_feedback() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.UpdateUserFeedbackRequest() + + +@pytest.mark.asyncio +async def test_update_user_feedback_async(transport: str = 'grpc_asyncio', request_type=question_service.UpdateUserFeedbackRequest): + client = QuestionServiceAsyncClient( + 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_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback( + name='name_value', + free_form_feedback='free_form_feedback_value', + rating=gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, + )) + response = await client.update_user_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == question_service.UpdateUserFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcd_user_feedback.UserFeedback) + assert response.name == 'name_value' + assert response.free_form_feedback == 'free_form_feedback_value' + assert response.rating == gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE + + +@pytest.mark.asyncio +async def test_update_user_feedback_async_from_dict(): + await test_update_user_feedback_async(request_type=dict) + + +def test_update_user_feedback_field_headers(): + client = QuestionServiceClient( + 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 = question_service.UpdateUserFeedbackRequest() + + request.user_feedback.name = 'user_feedback.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_user_feedback), + '__call__') as call: + call.return_value = gcd_user_feedback.UserFeedback() + client.update_user_feedback(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', + 'user_feedback.name=user_feedback.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_user_feedback_field_headers_async(): + client = QuestionServiceAsyncClient( + 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 = question_service.UpdateUserFeedbackRequest() + + request.user_feedback.name = 'user_feedback.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_user_feedback), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback()) + await client.update_user_feedback(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', + 'user_feedback.name=user_feedback.name/value', + ) in kw['metadata'] + + +def test_update_user_feedback_flattened(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_user_feedback.UserFeedback() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_user_feedback( + user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].user_feedback == gcd_user_feedback.UserFeedback(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_user_feedback_flattened_error(): + client = QuestionServiceClient( + 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_user_feedback( + question_service.UpdateUserFeedbackRequest(), + user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_user_feedback_flattened_async(): + client = QuestionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_user_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcd_user_feedback.UserFeedback() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_user_feedback( + user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].user_feedback == gcd_user_feedback.UserFeedback(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_user_feedback_flattened_error_async(): + client = QuestionServiceAsyncClient( + 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_user_feedback( + question_service.UpdateUserFeedbackRequest(), + user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.QuestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.QuestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuestionServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.QuestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuestionServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.QuestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = QuestionServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.QuestionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.QuestionServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.QuestionServiceGrpcTransport, + transports.QuestionServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.QuestionServiceGrpcTransport, + ) + +def test_question_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.QuestionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_question_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.QuestionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'get_question', + 'create_question', + 'execute_question', + 'get_user_feedback', + 'update_user_feedback', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_question_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.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.QuestionServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_question_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.QuestionServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_question_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.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.QuestionServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_question_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) + QuestionServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_question_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + QuestionServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuestionServiceGrpcTransport, + transports.QuestionServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_question_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.QuestionServiceGrpcTransport, + transports.QuestionServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_question_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.QuestionServiceGrpcTransport, grpc_helpers), + (transports.QuestionServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_question_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( + "dataqna.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="dataqna.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) +def test_question_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_question_service_host_no_port(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com'), + ) + assert client.transport._host == 'dataqna.googleapis.com:443' + + +def test_question_service_host_with_port(): + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com:8000'), + ) + assert client.transport._host == 'dataqna.googleapis.com:8000' + +def test_question_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.QuestionServiceGrpcTransport( + 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_question_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.QuestionServiceGrpcAsyncIOTransport( + 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.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) +def test_question_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) +def test_question_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_question_path(): + project = "squid" + location = "clam" + question = "whelk" + expected = "projects/{project}/locations/{location}/questions/{question}".format(project=project, location=location, question=question, ) + actual = QuestionServiceClient.question_path(project, location, question) + assert expected == actual + + +def test_parse_question_path(): + expected = { + "project": "octopus", + "location": "oyster", + "question": "nudibranch", + } + path = QuestionServiceClient.question_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_question_path(path) + assert expected == actual + +def test_user_feedback_path(): + project = "cuttlefish" + location = "mussel" + question = "winkle" + expected = "projects/{project}/locations/{location}/questions/{question}/userFeedback".format(project=project, location=location, question=question, ) + actual = QuestionServiceClient.user_feedback_path(project, location, question) + assert expected == actual + + +def test_parse_user_feedback_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "question": "abalone", + } + path = QuestionServiceClient.user_feedback_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_user_feedback_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = QuestionServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = QuestionServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = QuestionServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = QuestionServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = QuestionServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = QuestionServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = QuestionServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = QuestionServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = QuestionServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = QuestionServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = QuestionServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.QuestionServiceTransport, '_prep_wrapped_messages') as prep: + client = QuestionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.QuestionServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = QuestionServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From 33cc5c7597224ef07514bb10036fcc047674198b Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 22 Jun 2021 00:25:45 +0000 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md --- .coveragerc | 1 - .../transports/base.py | 40 +- .../transports/grpc.py | 7 +- .../transports/grpc_asyncio.py | 7 +- .../question_service/transports/base.py | 40 +- .../question_service/transports/grpc.py | 7 +- .../transports/grpc_asyncio.py | 7 +- owl-bot-staging/v1alpha/.coveragerc | 17 - owl-bot-staging/v1alpha/MANIFEST.in | 2 - owl-bot-staging/v1alpha/README.rst | 49 - owl-bot-staging/v1alpha/docs/conf.py | 376 --- .../auto_suggestion_service.rst | 6 - .../docs/dataqna_v1alpha/question_service.rst | 6 - .../v1alpha/docs/dataqna_v1alpha/services.rst | 7 - .../v1alpha/docs/dataqna_v1alpha/types.rst | 7 - owl-bot-staging/v1alpha/docs/index.rst | 7 - .../v1alpha/google/cloud/dataqna/__init__.py | 71 - .../v1alpha/google/cloud/dataqna/py.typed | 2 - .../google/cloud/dataqna_v1alpha/__init__.py | 72 - .../cloud/dataqna_v1alpha/gapic_metadata.json | 97 - .../google/cloud/dataqna_v1alpha/py.typed | 2 - .../dataqna_v1alpha/services/__init__.py | 15 - .../auto_suggestion_service/__init__.py | 22 - .../auto_suggestion_service/async_client.py | 284 --- .../auto_suggestion_service/client.py | 463 ---- .../transports/__init__.py | 33 - .../transports/base.py | 168 -- .../transports/grpc.py | 320 --- .../transports/grpc_asyncio.py | 324 --- .../services/question_service/__init__.py | 22 - .../services/question_service/async_client.py | 600 ----- .../services/question_service/client.py | 796 ------ .../question_service/transports/__init__.py | 33 - .../question_service/transports/base.py | 228 -- .../question_service/transports/grpc.py | 374 --- .../transports/grpc_asyncio.py | 378 --- .../cloud/dataqna_v1alpha/types/__init__.py | 72 - .../dataqna_v1alpha/types/annotated_string.py | 120 - .../types/auto_suggestion_service.py | 199 -- .../cloud/dataqna_v1alpha/types/question.py | 593 ----- .../dataqna_v1alpha/types/question_service.py | 138 -- .../dataqna_v1alpha/types/user_feedback.py | 60 - owl-bot-staging/v1alpha/mypy.ini | 3 - owl-bot-staging/v1alpha/noxfile.py | 132 - .../scripts/fixup_dataqna_v1alpha_keywords.py | 181 -- owl-bot-staging/v1alpha/setup.py | 53 - owl-bot-staging/v1alpha/tests/__init__.py | 16 - .../v1alpha/tests/unit/__init__.py | 16 - .../v1alpha/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/dataqna_v1alpha/__init__.py | 16 - .../test_auto_suggestion_service.py | 1052 -------- .../dataqna_v1alpha/test_question_service.py | 2197 ----------------- .../test_auto_suggestion_service.py | 104 +- .../dataqna_v1alpha/test_question_service.py | 104 +- 54 files changed, 74 insertions(+), 9888 deletions(-) delete mode 100644 owl-bot-staging/v1alpha/.coveragerc delete mode 100644 owl-bot-staging/v1alpha/MANIFEST.in delete mode 100644 owl-bot-staging/v1alpha/README.rst delete mode 100644 owl-bot-staging/v1alpha/docs/conf.py delete mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst delete mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst delete mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst delete mode 100644 owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst delete mode 100644 owl-bot-staging/v1alpha/docs/index.rst delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py delete mode 100644 owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py delete mode 100644 owl-bot-staging/v1alpha/mypy.ini delete mode 100644 owl-bot-staging/v1alpha/noxfile.py delete mode 100644 owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py delete mode 100644 owl-bot-staging/v1alpha/setup.py delete mode 100644 owl-bot-staging/v1alpha/tests/__init__.py delete mode 100644 owl-bot-staging/v1alpha/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py delete mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py delete mode 100644 owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py diff --git a/.coveragerc b/.coveragerc index 48d75b4..017250b 100644 --- a/.coveragerc +++ b/.coveragerc @@ -2,7 +2,6 @@ branch = True [report] -fail_under = 100 show_missing = True omit = google/cloud/dataqna/__init__.py diff --git a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py index 3cd57ca..8b318c0 100644 --- a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py +++ b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py @@ -24,6 +24,7 @@ from google.api_core import gapic_v1 # type: ignore from google.api_core import retry as retries # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore from google.cloud.dataqna_v1alpha.types import auto_suggestion_service @@ -43,8 +44,6 @@ except pkg_resources.DistributionNotFound: # pragma: NO COVER _GOOGLE_AUTH_VERSION = None -_API_CORE_VERSION = google.api_core.__version__ - class AutoSuggestionServiceTransport(abc.ABC): """Abstract transport class for AutoSuggestionService.""" @@ -62,6 +61,7 @@ def __init__( scopes: Optional[Sequence[str]] = None, quota_project_id: Optional[str] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, **kwargs, ) -> None: """Instantiate the transport. @@ -85,6 +85,8 @@ def __init__( API requests. If ``None``, then default info will be used. Generally, you only need to set this if you're developing your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. """ # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: @@ -113,13 +115,20 @@ def __init__( **scopes_kwargs, quota_project_id=quota_project_id ) + # If the credentials is service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + # Save the credentials. self._credentials = credentials - # TODO(busunkim): These two class methods are in the base transport + # TODO(busunkim): This method is in the base transport # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-api-core - # and google-auth are increased. + # should be deleted once the minimum required versions of google-auth is increased. # TODO: Remove this function once google-auth >= 1.25.0 is required @classmethod @@ -140,27 +149,6 @@ def _get_scopes_kwargs( return scopes_kwargs - # TODO: Remove this function once google-api-core >= 1.26.0 is required - @classmethod - def _get_self_signed_jwt_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Union[Optional[Sequence[str]], str]]: - """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" - - self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} - - if _API_CORE_VERSION and ( - packaging.version.parse(_API_CORE_VERSION) - >= packaging.version.parse("1.26.0") - ): - self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES - self_signed_jwt_kwargs["scopes"] = scopes - self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST - else: - self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES - - return self_signed_jwt_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { diff --git a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py index 2a364c3..800b5b2 100644 --- a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py +++ b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py @@ -219,6 +219,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: @@ -274,14 +275,14 @@ def create_channel( and ``credentials_file`` are passed. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) diff --git a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py index f10da78..7d7f504 100644 --- a/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py +++ b/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py @@ -148,14 +148,14 @@ def create_channel( aio.Channel: A gRPC AsyncIO channel object. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers_async.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) @@ -265,6 +265,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: diff --git a/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py b/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py index b224da2..78870de 100644 --- a/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py +++ b/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py @@ -24,6 +24,7 @@ from google.api_core import gapic_v1 # type: ignore from google.api_core import retry as retries # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore from google.cloud.dataqna_v1alpha.types import question from google.cloud.dataqna_v1alpha.types import question as gcd_question @@ -47,8 +48,6 @@ except pkg_resources.DistributionNotFound: # pragma: NO COVER _GOOGLE_AUTH_VERSION = None -_API_CORE_VERSION = google.api_core.__version__ - class QuestionServiceTransport(abc.ABC): """Abstract transport class for QuestionService.""" @@ -66,6 +65,7 @@ def __init__( scopes: Optional[Sequence[str]] = None, quota_project_id: Optional[str] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, **kwargs, ) -> None: """Instantiate the transport. @@ -89,6 +89,8 @@ def __init__( API requests. If ``None``, then default info will be used. Generally, you only need to set this if you're developing your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. """ # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: @@ -117,13 +119,20 @@ def __init__( **scopes_kwargs, quota_project_id=quota_project_id ) + # If the credentials is service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + # Save the credentials. self._credentials = credentials - # TODO(busunkim): These two class methods are in the base transport + # TODO(busunkim): This method is in the base transport # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-api-core - # and google-auth are increased. + # should be deleted once the minimum required versions of google-auth is increased. # TODO: Remove this function once google-auth >= 1.25.0 is required @classmethod @@ -144,27 +153,6 @@ def _get_scopes_kwargs( return scopes_kwargs - # TODO: Remove this function once google-api-core >= 1.26.0 is required - @classmethod - def _get_self_signed_jwt_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Union[Optional[Sequence[str]], str]]: - """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" - - self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} - - if _API_CORE_VERSION and ( - packaging.version.parse(_API_CORE_VERSION) - >= packaging.version.parse("1.26.0") - ): - self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES - self_signed_jwt_kwargs["scopes"] = scopes - self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST - else: - self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES - - return self_signed_jwt_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { diff --git a/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py b/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py index 3fc22e9..630f9e4 100644 --- a/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py +++ b/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py @@ -169,6 +169,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: @@ -224,14 +225,14 @@ def create_channel( and ``credentials_file`` are passed. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) diff --git a/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py b/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py index f1d41da..9807fc0 100644 --- a/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py +++ b/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py @@ -98,14 +98,14 @@ def create_channel( aio.Channel: A gRPC AsyncIO channel object. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers_async.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) @@ -215,6 +215,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: diff --git a/owl-bot-staging/v1alpha/.coveragerc b/owl-bot-staging/v1alpha/.coveragerc deleted file mode 100644 index 017250b..0000000 --- a/owl-bot-staging/v1alpha/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/dataqna/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1alpha/MANIFEST.in b/owl-bot-staging/v1alpha/MANIFEST.in deleted file mode 100644 index cd6cbb6..0000000 --- a/owl-bot-staging/v1alpha/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/dataqna *.py -recursive-include google/cloud/dataqna_v1alpha *.py diff --git a/owl-bot-staging/v1alpha/README.rst b/owl-bot-staging/v1alpha/README.rst deleted file mode 100644 index 15fd204..0000000 --- a/owl-bot-staging/v1alpha/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Dataqna 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 Dataqna 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/v1alpha/docs/conf.py b/owl-bot-staging/v1alpha/docs/conf.py deleted file mode 100644 index d0bbe40..0000000 --- a/owl-bot-staging/v1alpha/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-dataqna documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "1.6.3" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-dataqna" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-dataqna-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "google-cloud-dataqna.tex", - u"google-cloud-dataqna Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - master_doc, - "google-cloud-dataqna", - u"Google Cloud Dataqna Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "google-cloud-dataqna", - u"google-cloud-dataqna Documentation", - author, - "google-cloud-dataqna", - "GAPIC library for Google Cloud Dataqna 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/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst deleted file mode 100644 index 4a96dd5..0000000 --- a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/auto_suggestion_service.rst +++ /dev/null @@ -1,6 +0,0 @@ -AutoSuggestionService ---------------------------------------- - -.. automodule:: google.cloud.dataqna_v1alpha.services.auto_suggestion_service - :members: - :inherited-members: diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst deleted file mode 100644 index 0c7fe89..0000000 --- a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/question_service.rst +++ /dev/null @@ -1,6 +0,0 @@ -QuestionService ---------------------------------- - -.. automodule:: google.cloud.dataqna_v1alpha.services.question_service - :members: - :inherited-members: diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst deleted file mode 100644 index 00a6eb5..0000000 --- a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/services.rst +++ /dev/null @@ -1,7 +0,0 @@ -Services for Google Cloud Dataqna v1alpha API -============================================= -.. toctree:: - :maxdepth: 2 - - auto_suggestion_service - question_service diff --git a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst b/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst deleted file mode 100644 index 66f9ab9..0000000 --- a/owl-bot-staging/v1alpha/docs/dataqna_v1alpha/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Dataqna v1alpha API -========================================== - -.. automodule:: google.cloud.dataqna_v1alpha.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1alpha/docs/index.rst b/owl-bot-staging/v1alpha/docs/index.rst deleted file mode 100644 index f70fe42..0000000 --- a/owl-bot-staging/v1alpha/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - dataqna_v1alpha/services - dataqna_v1alpha/types diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py deleted file mode 100644 index d1ce521..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna/__init__.py +++ /dev/null @@ -1,71 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.client import AutoSuggestionServiceClient -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.async_client import AutoSuggestionServiceAsyncClient -from google.cloud.dataqna_v1alpha.services.question_service.client import QuestionServiceClient -from google.cloud.dataqna_v1alpha.services.question_service.async_client import QuestionServiceAsyncClient - -from google.cloud.dataqna_v1alpha.types.annotated_string import AnnotatedString -from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import Suggestion -from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestionInfo -from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestQueriesRequest -from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestQueriesResponse -from google.cloud.dataqna_v1alpha.types.auto_suggestion_service import SuggestionType -from google.cloud.dataqna_v1alpha.types.question import BigQueryJob -from google.cloud.dataqna_v1alpha.types.question import DataQuery -from google.cloud.dataqna_v1alpha.types.question import DebugFlags -from google.cloud.dataqna_v1alpha.types.question import ExecutionInfo -from google.cloud.dataqna_v1alpha.types.question import HumanReadable -from google.cloud.dataqna_v1alpha.types.question import Interpretation -from google.cloud.dataqna_v1alpha.types.question import InterpretationStructure -from google.cloud.dataqna_v1alpha.types.question import InterpretError -from google.cloud.dataqna_v1alpha.types.question import Question -from google.cloud.dataqna_v1alpha.types.question import InterpretEntity -from google.cloud.dataqna_v1alpha.types.question_service import CreateQuestionRequest -from google.cloud.dataqna_v1alpha.types.question_service import ExecuteQuestionRequest -from google.cloud.dataqna_v1alpha.types.question_service import GetQuestionRequest -from google.cloud.dataqna_v1alpha.types.question_service import GetUserFeedbackRequest -from google.cloud.dataqna_v1alpha.types.question_service import UpdateUserFeedbackRequest -from google.cloud.dataqna_v1alpha.types.user_feedback import UserFeedback - -__all__ = ('AutoSuggestionServiceClient', - 'AutoSuggestionServiceAsyncClient', - 'QuestionServiceClient', - 'QuestionServiceAsyncClient', - 'AnnotatedString', - 'Suggestion', - 'SuggestionInfo', - 'SuggestQueriesRequest', - 'SuggestQueriesResponse', - 'SuggestionType', - 'BigQueryJob', - 'DataQuery', - 'DebugFlags', - 'ExecutionInfo', - 'HumanReadable', - 'Interpretation', - 'InterpretationStructure', - 'InterpretError', - 'Question', - 'InterpretEntity', - 'CreateQuestionRequest', - 'ExecuteQuestionRequest', - 'GetQuestionRequest', - 'GetUserFeedbackRequest', - 'UpdateUserFeedbackRequest', - 'UserFeedback', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed b/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed deleted file mode 100644 index 305ad75..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-dataqna package uses inline types. diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py deleted file mode 100644 index c29f2c5..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/__init__.py +++ /dev/null @@ -1,72 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .services.auto_suggestion_service import AutoSuggestionServiceClient -from .services.auto_suggestion_service import AutoSuggestionServiceAsyncClient -from .services.question_service import QuestionServiceClient -from .services.question_service import QuestionServiceAsyncClient - -from .types.annotated_string import AnnotatedString -from .types.auto_suggestion_service import Suggestion -from .types.auto_suggestion_service import SuggestionInfo -from .types.auto_suggestion_service import SuggestQueriesRequest -from .types.auto_suggestion_service import SuggestQueriesResponse -from .types.auto_suggestion_service import SuggestionType -from .types.question import BigQueryJob -from .types.question import DataQuery -from .types.question import DebugFlags -from .types.question import ExecutionInfo -from .types.question import HumanReadable -from .types.question import Interpretation -from .types.question import InterpretationStructure -from .types.question import InterpretError -from .types.question import Question -from .types.question import InterpretEntity -from .types.question_service import CreateQuestionRequest -from .types.question_service import ExecuteQuestionRequest -from .types.question_service import GetQuestionRequest -from .types.question_service import GetUserFeedbackRequest -from .types.question_service import UpdateUserFeedbackRequest -from .types.user_feedback import UserFeedback - -__all__ = ( - 'AutoSuggestionServiceAsyncClient', - 'QuestionServiceAsyncClient', -'AnnotatedString', -'AutoSuggestionServiceClient', -'BigQueryJob', -'CreateQuestionRequest', -'DataQuery', -'DebugFlags', -'ExecuteQuestionRequest', -'ExecutionInfo', -'GetQuestionRequest', -'GetUserFeedbackRequest', -'HumanReadable', -'InterpretEntity', -'InterpretError', -'Interpretation', -'InterpretationStructure', -'Question', -'QuestionServiceClient', -'SuggestQueriesRequest', -'SuggestQueriesResponse', -'Suggestion', -'SuggestionInfo', -'SuggestionType', -'UpdateUserFeedbackRequest', -'UserFeedback', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json deleted file mode 100644 index 7ba1907..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/gapic_metadata.json +++ /dev/null @@ -1,97 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.dataqna_v1alpha", - "protoPackage": "google.cloud.dataqna.v1alpha", - "schema": "1.0", - "services": { - "AutoSuggestionService": { - "clients": { - "grpc": { - "libraryClient": "AutoSuggestionServiceClient", - "rpcs": { - "SuggestQueries": { - "methods": [ - "suggest_queries" - ] - } - } - }, - "grpc-async": { - "libraryClient": "AutoSuggestionServiceAsyncClient", - "rpcs": { - "SuggestQueries": { - "methods": [ - "suggest_queries" - ] - } - } - } - } - }, - "QuestionService": { - "clients": { - "grpc": { - "libraryClient": "QuestionServiceClient", - "rpcs": { - "CreateQuestion": { - "methods": [ - "create_question" - ] - }, - "ExecuteQuestion": { - "methods": [ - "execute_question" - ] - }, - "GetQuestion": { - "methods": [ - "get_question" - ] - }, - "GetUserFeedback": { - "methods": [ - "get_user_feedback" - ] - }, - "UpdateUserFeedback": { - "methods": [ - "update_user_feedback" - ] - } - } - }, - "grpc-async": { - "libraryClient": "QuestionServiceAsyncClient", - "rpcs": { - "CreateQuestion": { - "methods": [ - "create_question" - ] - }, - "ExecuteQuestion": { - "methods": [ - "execute_question" - ] - }, - "GetQuestion": { - "methods": [ - "get_question" - ] - }, - "GetUserFeedback": { - "methods": [ - "get_user_feedback" - ] - }, - "UpdateUserFeedback": { - "methods": [ - "update_user_feedback" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed deleted file mode 100644 index 305ad75..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-dataqna package uses inline types. diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py deleted file mode 100644 index eebfd7b..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import AutoSuggestionServiceClient -from .async_client import AutoSuggestionServiceAsyncClient - -__all__ = ( - 'AutoSuggestionServiceClient', - 'AutoSuggestionServiceAsyncClient', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py deleted file mode 100644 index d9417e9..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/async_client.py +++ /dev/null @@ -1,284 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service -from .transports.base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport -from .client import AutoSuggestionServiceClient - - -class AutoSuggestionServiceAsyncClient: - """This stateless API provides automatic suggestions for natural - language queries for the data sources in the provided project and - location. - - The service provides a resourceless operation ``suggestQueries`` - that can be called to get a list of suggestions for a given - incomplete query and scope (or list of scopes) under which the query - is to be interpreted. - - There are two types of suggestions, ENTITY for single entity - suggestions and TEMPLATE for full sentences. By default, both types - are returned. - - Example Request: - - :: - - GetSuggestions({ - parent: "locations/us/projects/my-project" - scopes: - "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" - query: "top it" - }) - - The service will retrieve information based on the given scope(s) - and give suggestions based on that (e.g. "top item" for "top it" if - "item" is a known dimension for the provided scope). - - :: - - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "top item by sum of usd_revenue_net" - markups { - type: DIMENSION - start_char_index: 4 - length: 4 - } - markups { - type: METRIC - start_char_index: 19 - length: 15 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: TEMPLATE - ranking_score: 0.9 - } - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "item" - markups { - type: DIMENSION - start_char_index: 4 - length: 2 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: ENTITY - ranking_score: 0.8 - } - """ - - _client: AutoSuggestionServiceClient - - DEFAULT_ENDPOINT = AutoSuggestionServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = AutoSuggestionServiceClient.DEFAULT_MTLS_ENDPOINT - - common_billing_account_path = staticmethod(AutoSuggestionServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(AutoSuggestionServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(AutoSuggestionServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(AutoSuggestionServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(AutoSuggestionServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(AutoSuggestionServiceClient.parse_common_organization_path) - common_project_path = staticmethod(AutoSuggestionServiceClient.common_project_path) - parse_common_project_path = staticmethod(AutoSuggestionServiceClient.parse_common_project_path) - common_location_path = staticmethod(AutoSuggestionServiceClient.common_location_path) - parse_common_location_path = staticmethod(AutoSuggestionServiceClient.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: - AutoSuggestionServiceAsyncClient: The constructed client. - """ - return AutoSuggestionServiceClient.from_service_account_info.__func__(AutoSuggestionServiceAsyncClient, 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: - AutoSuggestionServiceAsyncClient: The constructed client. - """ - return AutoSuggestionServiceClient.from_service_account_file.__func__(AutoSuggestionServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> AutoSuggestionServiceTransport: - """Returns the transport used by the client instance. - - Returns: - AutoSuggestionServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(AutoSuggestionServiceClient).get_transport_class, type(AutoSuggestionServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, AutoSuggestionServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the auto suggestion 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, ~.AutoSuggestionServiceTransport]): 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 = AutoSuggestionServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def suggest_queries(self, - request: auto_suggestion_service.SuggestQueriesRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> auto_suggestion_service.SuggestQueriesResponse: - r"""Gets a list of suggestions based on a prefix string. - AutoSuggestion tolerance should be less than 1 second. - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.SuggestQueriesRequest`): - The request object. Request for query suggestions. - 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.dataqna_v1alpha.types.SuggestQueriesResponse: - Response to SuggestQueries. - """ - # Create or coerce a protobuf request object. - request = auto_suggestion_service.SuggestQueriesRequest(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.suggest_queries, - 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, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-dataqna", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "AutoSuggestionServiceAsyncClient", -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py deleted file mode 100644 index a3be175..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/client.py +++ /dev/null @@ -1,463 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service -from .transports.base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import AutoSuggestionServiceGrpcTransport -from .transports.grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport - - -class AutoSuggestionServiceClientMeta(type): - """Metaclass for the AutoSuggestionService 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[AutoSuggestionServiceTransport]] - _transport_registry["grpc"] = AutoSuggestionServiceGrpcTransport - _transport_registry["grpc_asyncio"] = AutoSuggestionServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[AutoSuggestionServiceTransport]: - """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 AutoSuggestionServiceClient(metaclass=AutoSuggestionServiceClientMeta): - """This stateless API provides automatic suggestions for natural - language queries for the data sources in the provided project and - location. - - The service provides a resourceless operation ``suggestQueries`` - that can be called to get a list of suggestions for a given - incomplete query and scope (or list of scopes) under which the query - is to be interpreted. - - There are two types of suggestions, ENTITY for single entity - suggestions and TEMPLATE for full sentences. By default, both types - are returned. - - Example Request: - - :: - - GetSuggestions({ - parent: "locations/us/projects/my-project" - scopes: - "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" - query: "top it" - }) - - The service will retrieve information based on the given scope(s) - and give suggestions based on that (e.g. "top item" for "top it" if - "item" is a known dimension for the provided scope). - - :: - - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "top item by sum of usd_revenue_net" - markups { - type: DIMENSION - start_char_index: 4 - length: 4 - } - markups { - type: METRIC - start_char_index: 19 - length: 15 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: TEMPLATE - ranking_score: 0.9 - } - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "item" - markups { - type: DIMENSION - start_char_index: 4 - length: 2 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: ENTITY - ranking_score: 0.8 - } - """ - - @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 = "dataqna.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: - AutoSuggestionServiceClient: 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: - AutoSuggestionServiceClient: 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) -> AutoSuggestionServiceTransport: - """Returns the transport used by the client instance. - - Returns: - AutoSuggestionServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, AutoSuggestionServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the auto suggestion 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, AutoSuggestionServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, AutoSuggestionServiceTransport): - # transport is a AutoSuggestionServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - ) - - def suggest_queries(self, - request: auto_suggestion_service.SuggestQueriesRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> auto_suggestion_service.SuggestQueriesResponse: - r"""Gets a list of suggestions based on a prefix string. - AutoSuggestion tolerance should be less than 1 second. - - Args: - request (google.cloud.dataqna_v1alpha.types.SuggestQueriesRequest): - The request object. Request for query suggestions. - 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.dataqna_v1alpha.types.SuggestQueriesResponse: - Response to SuggestQueries. - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a auto_suggestion_service.SuggestQueriesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, auto_suggestion_service.SuggestQueriesRequest): - request = auto_suggestion_service.SuggestQueriesRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.suggest_queries] - - # 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 - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-dataqna", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "AutoSuggestionServiceClient", -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py deleted file mode 100644 index eebc1cb..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import AutoSuggestionServiceTransport -from .grpc import AutoSuggestionServiceGrpcTransport -from .grpc_asyncio import AutoSuggestionServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[AutoSuggestionServiceTransport]] -_transport_registry['grpc'] = AutoSuggestionServiceGrpcTransport -_transport_registry['grpc_asyncio'] = AutoSuggestionServiceGrpcAsyncIOTransport - -__all__ = ( - 'AutoSuggestionServiceTransport', - 'AutoSuggestionServiceGrpcTransport', - 'AutoSuggestionServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py deleted file mode 100644 index 65b7eb0..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/base.py +++ /dev/null @@ -1,168 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-dataqna', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class AutoSuggestionServiceTransport(abc.ABC): - """Abstract transport class for AutoSuggestionService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'dataqna.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes or self.AUTH_SCOPES - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.suggest_queries: gapic_v1.method.wrap_method( - self.suggest_queries, - default_timeout=None, - client_info=client_info, - ), - } - - @property - def suggest_queries(self) -> Callable[ - [auto_suggestion_service.SuggestQueriesRequest], - Union[ - auto_suggestion_service.SuggestQueriesResponse, - Awaitable[auto_suggestion_service.SuggestQueriesResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'AutoSuggestionServiceTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py deleted file mode 100644 index 74846e6..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc.py +++ /dev/null @@ -1,320 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import gapic_v1 # type: ignore -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service -from .base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO - - -class AutoSuggestionServiceGrpcTransport(AutoSuggestionServiceTransport): - """gRPC backend transport for AutoSuggestionService. - - This stateless API provides automatic suggestions for natural - language queries for the data sources in the provided project and - location. - - The service provides a resourceless operation ``suggestQueries`` - that can be called to get a list of suggestions for a given - incomplete query and scope (or list of scopes) under which the query - is to be interpreted. - - There are two types of suggestions, ENTITY for single entity - suggestions and TEMPLATE for full sentences. By default, both types - are returned. - - Example Request: - - :: - - GetSuggestions({ - parent: "locations/us/projects/my-project" - scopes: - "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" - query: "top it" - }) - - The service will retrieve information based on the given scope(s) - and give suggestions based on that (e.g. "top item" for "top it" if - "item" is a known dimension for the provided scope). - - :: - - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "top item by sum of usd_revenue_net" - markups { - type: DIMENSION - start_char_index: 4 - length: 4 - } - markups { - type: METRIC - start_char_index: 19 - length: 15 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: TEMPLATE - ranking_score: 0.9 - } - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "item" - markups { - type: DIMENSION - start_char_index: 4 - length: 2 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: ENTITY - ranking_score: 0.8 - } - - 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 = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def suggest_queries(self) -> Callable[ - [auto_suggestion_service.SuggestQueriesRequest], - auto_suggestion_service.SuggestQueriesResponse]: - r"""Return a callable for the suggest queries method over gRPC. - - Gets a list of suggestions based on a prefix string. - AutoSuggestion tolerance should be less than 1 second. - - Returns: - Callable[[~.SuggestQueriesRequest], - ~.SuggestQueriesResponse]: - 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 'suggest_queries' not in self._stubs: - self._stubs['suggest_queries'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.AutoSuggestionService/SuggestQueries', - request_serializer=auto_suggestion_service.SuggestQueriesRequest.serialize, - response_deserializer=auto_suggestion_service.SuggestQueriesResponse.deserialize, - ) - return self._stubs['suggest_queries'] - - -__all__ = ( - 'AutoSuggestionServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py deleted file mode 100644 index c12c04d..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/auto_suggestion_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,324 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service -from .base import AutoSuggestionServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import AutoSuggestionServiceGrpcTransport - - -class AutoSuggestionServiceGrpcAsyncIOTransport(AutoSuggestionServiceTransport): - """gRPC AsyncIO backend transport for AutoSuggestionService. - - This stateless API provides automatic suggestions for natural - language queries for the data sources in the provided project and - location. - - The service provides a resourceless operation ``suggestQueries`` - that can be called to get a list of suggestions for a given - incomplete query and scope (or list of scopes) under which the query - is to be interpreted. - - There are two types of suggestions, ENTITY for single entity - suggestions and TEMPLATE for full sentences. By default, both types - are returned. - - Example Request: - - :: - - GetSuggestions({ - parent: "locations/us/projects/my-project" - scopes: - "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" - query: "top it" - }) - - The service will retrieve information based on the given scope(s) - and give suggestions based on that (e.g. "top item" for "top it" if - "item" is a known dimension for the provided scope). - - :: - - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "top item by sum of usd_revenue_net" - markups { - type: DIMENSION - start_char_index: 4 - length: 4 - } - markups { - type: METRIC - start_char_index: 19 - length: 15 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: TEMPLATE - ranking_score: 0.9 - } - suggestions { - suggestion_info { - annotated_suggestion { - text_formatted: "item" - markups { - type: DIMENSION - start_char_index: 4 - length: 2 - } - } - query_matches { - start_char_index: 0 - length: 6 - } - } - suggestion_type: ENTITY - ranking_score: 0.8 - } - - 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 = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def suggest_queries(self) -> Callable[ - [auto_suggestion_service.SuggestQueriesRequest], - Awaitable[auto_suggestion_service.SuggestQueriesResponse]]: - r"""Return a callable for the suggest queries method over gRPC. - - Gets a list of suggestions based on a prefix string. - AutoSuggestion tolerance should be less than 1 second. - - Returns: - Callable[[~.SuggestQueriesRequest], - Awaitable[~.SuggestQueriesResponse]]: - 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 'suggest_queries' not in self._stubs: - self._stubs['suggest_queries'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.AutoSuggestionService/SuggestQueries', - request_serializer=auto_suggestion_service.SuggestQueriesRequest.serialize, - response_deserializer=auto_suggestion_service.SuggestQueriesResponse.deserialize, - ) - return self._stubs['suggest_queries'] - - -__all__ = ( - 'AutoSuggestionServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py deleted file mode 100644 index 6042509..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import QuestionServiceClient -from .async_client import QuestionServiceAsyncClient - -__all__ = ( - 'QuestionServiceClient', - 'QuestionServiceAsyncClient', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py deleted file mode 100644 index cd81acc..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/async_client.py +++ /dev/null @@ -1,600 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from google.protobuf import any_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import QuestionServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import QuestionServiceGrpcAsyncIOTransport -from .client import QuestionServiceClient - - -class QuestionServiceAsyncClient: - """Service to interpret natural language queries. The service allows to - create ``Question`` resources that are interpreted and are filled - with one or more interpretations if the question could be - interpreted. Once a ``Question`` resource is created and has at - least one interpretation, an interpretation can be chosen for - execution, which triggers a query to the backend (for BigQuery, it - will create a job). Upon successful execution of that - interpretation, backend specific information will be returned so - that the client can retrieve the results from the backend. - - The ``Question`` resources are named - ``projects/*/locations/*/questions/*``. - - The ``Question`` resource has a singletion sub-resource - ``UserFeedback`` named - ``projects/*/locations/*/questions/*/userFeedback``, which allows - access to user feedback. - """ - - _client: QuestionServiceClient - - DEFAULT_ENDPOINT = QuestionServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = QuestionServiceClient.DEFAULT_MTLS_ENDPOINT - - question_path = staticmethod(QuestionServiceClient.question_path) - parse_question_path = staticmethod(QuestionServiceClient.parse_question_path) - user_feedback_path = staticmethod(QuestionServiceClient.user_feedback_path) - parse_user_feedback_path = staticmethod(QuestionServiceClient.parse_user_feedback_path) - common_billing_account_path = staticmethod(QuestionServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(QuestionServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(QuestionServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(QuestionServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(QuestionServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(QuestionServiceClient.parse_common_organization_path) - common_project_path = staticmethod(QuestionServiceClient.common_project_path) - parse_common_project_path = staticmethod(QuestionServiceClient.parse_common_project_path) - common_location_path = staticmethod(QuestionServiceClient.common_location_path) - parse_common_location_path = staticmethod(QuestionServiceClient.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: - QuestionServiceAsyncClient: The constructed client. - """ - return QuestionServiceClient.from_service_account_info.__func__(QuestionServiceAsyncClient, 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: - QuestionServiceAsyncClient: The constructed client. - """ - return QuestionServiceClient.from_service_account_file.__func__(QuestionServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> QuestionServiceTransport: - """Returns the transport used by the client instance. - - Returns: - QuestionServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(QuestionServiceClient).get_transport_class, type(QuestionServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, QuestionServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the question 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, ~.QuestionServiceTransport]): 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 = QuestionServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def get_question(self, - request: question_service.GetQuestionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> question.Question: - r"""Gets a previously created question. - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.GetQuestionRequest`): - The request object. A request to get a previously - created question. - name (:class:`str`): - Required. The unique identifier for the question. - Example: ``projects/foo/locations/bar/questions/1234`` - - 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = question_service.GetQuestionRequest(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_question, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_question(self, - request: question_service.CreateQuestionRequest = None, - *, - parent: str = None, - question: gcd_question.Question = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcd_question.Question: - r"""Creates a question. - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.CreateQuestionRequest`): - The request object. Request to create a question - resource. - parent (:class:`str`): - Required. The name of the project this data source - reference belongs to. Example: - ``projects/foo/locations/bar`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - question (:class:`google.cloud.dataqna_v1alpha.types.Question`): - Required. The question to create. - This corresponds to the ``question`` 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, question]) - 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 = question_service.CreateQuestionRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if question is not None: - request.question = question - - # 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_question, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def execute_question(self, - request: question_service.ExecuteQuestionRequest = None, - *, - name: str = None, - interpretation_index: int = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> question.Question: - r"""Executes an interpretation. - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.ExecuteQuestionRequest`): - The request object. Request to execute an - interpretation. - name (:class:`str`): - Required. The unique identifier for the question. - Example: ``projects/foo/locations/bar/questions/1234`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - interpretation_index (:class:`int`): - Required. Index of the interpretation - to execute. - - This corresponds to the ``interpretation_index`` 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, interpretation_index]) - 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 = question_service.ExecuteQuestionRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if interpretation_index is not None: - request.interpretation_index = interpretation_index - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.execute_question, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_user_feedback(self, - request: question_service.GetUserFeedbackRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> user_feedback.UserFeedback: - r"""Gets previously created user feedback. - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.GetUserFeedbackRequest`): - The request object. Request to get user feedback. - name (:class:`str`): - Required. The unique identifier for the user feedback. - User feedback is a singleton resource on a Question. - Example: - ``projects/foo/locations/bar/questions/1234/userFeedback`` - - 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.dataqna_v1alpha.types.UserFeedback: - Feedback provided by a user. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = question_service.GetUserFeedbackRequest(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_user_feedback, - 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 update_user_feedback(self, - request: question_service.UpdateUserFeedbackRequest = None, - *, - user_feedback: gcd_user_feedback.UserFeedback = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcd_user_feedback.UserFeedback: - r"""Updates user feedback. This creates user feedback if - there was none before (upsert). - - Args: - request (:class:`google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest`): - The request object. Request to updates user feedback. - user_feedback (:class:`google.cloud.dataqna_v1alpha.types.UserFeedback`): - Required. The user feedback to - update. This can be called even if there - is no user feedback so far. The - feedback's name field is used to - identify the user feedback (and the - corresponding question) to update. - - This corresponds to the ``user_feedback`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - The list of fields to 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.dataqna_v1alpha.types.UserFeedback: - Feedback provided by a user. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([user_feedback, 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 = question_service.UpdateUserFeedbackRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if user_feedback is not None: - request.user_feedback = user_feedback - 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_user_feedback, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("user_feedback.name", request.user_feedback.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-dataqna", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "QuestionServiceAsyncClient", -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py deleted file mode 100644 index babbbbd..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/client.py +++ /dev/null @@ -1,796 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from google.protobuf import any_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import QuestionServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import QuestionServiceGrpcTransport -from .transports.grpc_asyncio import QuestionServiceGrpcAsyncIOTransport - - -class QuestionServiceClientMeta(type): - """Metaclass for the QuestionService 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[QuestionServiceTransport]] - _transport_registry["grpc"] = QuestionServiceGrpcTransport - _transport_registry["grpc_asyncio"] = QuestionServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[QuestionServiceTransport]: - """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 QuestionServiceClient(metaclass=QuestionServiceClientMeta): - """Service to interpret natural language queries. The service allows to - create ``Question`` resources that are interpreted and are filled - with one or more interpretations if the question could be - interpreted. Once a ``Question`` resource is created and has at - least one interpretation, an interpretation can be chosen for - execution, which triggers a query to the backend (for BigQuery, it - will create a job). Upon successful execution of that - interpretation, backend specific information will be returned so - that the client can retrieve the results from the backend. - - The ``Question`` resources are named - ``projects/*/locations/*/questions/*``. - - The ``Question`` resource has a singletion sub-resource - ``UserFeedback`` named - ``projects/*/locations/*/questions/*/userFeedback``, which allows - access to user feedback. - """ - - @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 = "dataqna.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: - QuestionServiceClient: 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: - QuestionServiceClient: 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) -> QuestionServiceTransport: - """Returns the transport used by the client instance. - - Returns: - QuestionServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def question_path(project: str,location: str,question: str,) -> str: - """Returns a fully-qualified question string.""" - return "projects/{project}/locations/{location}/questions/{question}".format(project=project, location=location, question=question, ) - - @staticmethod - def parse_question_path(path: str) -> Dict[str,str]: - """Parses a question path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/questions/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def user_feedback_path(project: str,location: str,question: str,) -> str: - """Returns a fully-qualified user_feedback string.""" - return "projects/{project}/locations/{location}/questions/{question}/userFeedback".format(project=project, location=location, question=question, ) - - @staticmethod - def parse_user_feedback_path(path: str) -> Dict[str,str]: - """Parses a user_feedback path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/questions/(?P.+?)/userFeedback$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, QuestionServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the question 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, QuestionServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, QuestionServiceTransport): - # transport is a QuestionServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - ) - - def get_question(self, - request: question_service.GetQuestionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> question.Question: - r"""Gets a previously created question. - - Args: - request (google.cloud.dataqna_v1alpha.types.GetQuestionRequest): - The request object. A request to get a previously - created question. - name (str): - Required. The unique identifier for the question. - Example: ``projects/foo/locations/bar/questions/1234`` - - 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a question_service.GetQuestionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, question_service.GetQuestionRequest): - request = question_service.GetQuestionRequest(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_question] - - # 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_question(self, - request: question_service.CreateQuestionRequest = None, - *, - parent: str = None, - question: gcd_question.Question = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcd_question.Question: - r"""Creates a question. - - Args: - request (google.cloud.dataqna_v1alpha.types.CreateQuestionRequest): - The request object. Request to create a question - resource. - parent (str): - Required. The name of the project this data source - reference belongs to. Example: - ``projects/foo/locations/bar`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - question (google.cloud.dataqna_v1alpha.types.Question): - Required. The question to create. - This corresponds to the ``question`` 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, question]) - 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 question_service.CreateQuestionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, question_service.CreateQuestionRequest): - request = question_service.CreateQuestionRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if question is not None: - request.question = question - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_question] - - # 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 execute_question(self, - request: question_service.ExecuteQuestionRequest = None, - *, - name: str = None, - interpretation_index: int = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> question.Question: - r"""Executes an interpretation. - - Args: - request (google.cloud.dataqna_v1alpha.types.ExecuteQuestionRequest): - The request object. Request to execute an - interpretation. - name (str): - Required. The unique identifier for the question. - Example: ``projects/foo/locations/bar/questions/1234`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - interpretation_index (int): - Required. Index of the interpretation - to execute. - - This corresponds to the ``interpretation_index`` 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.dataqna_v1alpha.types.Question: - The question resource represents a - natural language query, its settings, - understanding generated by the system, - and answer retrieval status. A question - cannot be modified. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, interpretation_index]) - 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 question_service.ExecuteQuestionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, question_service.ExecuteQuestionRequest): - request = question_service.ExecuteQuestionRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if interpretation_index is not None: - request.interpretation_index = interpretation_index - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.execute_question] - - # 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_user_feedback(self, - request: question_service.GetUserFeedbackRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> user_feedback.UserFeedback: - r"""Gets previously created user feedback. - - Args: - request (google.cloud.dataqna_v1alpha.types.GetUserFeedbackRequest): - The request object. Request to get user feedback. - name (str): - Required. The unique identifier for the user feedback. - User feedback is a singleton resource on a Question. - Example: - ``projects/foo/locations/bar/questions/1234/userFeedback`` - - 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.dataqna_v1alpha.types.UserFeedback: - Feedback provided by a user. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a question_service.GetUserFeedbackRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, question_service.GetUserFeedbackRequest): - request = question_service.GetUserFeedbackRequest(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_user_feedback] - - # 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_user_feedback(self, - request: question_service.UpdateUserFeedbackRequest = None, - *, - user_feedback: gcd_user_feedback.UserFeedback = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcd_user_feedback.UserFeedback: - r"""Updates user feedback. This creates user feedback if - there was none before (upsert). - - Args: - request (google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest): - The request object. Request to updates user feedback. - user_feedback (google.cloud.dataqna_v1alpha.types.UserFeedback): - Required. The user feedback to - update. This can be called even if there - is no user feedback so far. The - feedback's name field is used to - identify the user feedback (and the - corresponding question) to update. - - This corresponds to the ``user_feedback`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to 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.dataqna_v1alpha.types.UserFeedback: - Feedback provided by a user. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([user_feedback, 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 question_service.UpdateUserFeedbackRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, question_service.UpdateUserFeedbackRequest): - request = question_service.UpdateUserFeedbackRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if user_feedback is not None: - request.user_feedback = user_feedback - 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_user_feedback] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("user_feedback.name", request.user_feedback.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-dataqna", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "QuestionServiceClient", -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py deleted file mode 100644 index 8e4e3ea..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import QuestionServiceTransport -from .grpc import QuestionServiceGrpcTransport -from .grpc_asyncio import QuestionServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[QuestionServiceTransport]] -_transport_registry['grpc'] = QuestionServiceGrpcTransport -_transport_registry['grpc_asyncio'] = QuestionServiceGrpcAsyncIOTransport - -__all__ = ( - 'QuestionServiceTransport', - 'QuestionServiceGrpcTransport', - 'QuestionServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py deleted file mode 100644 index b33cc62..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/base.py +++ /dev/null @@ -1,228 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-dataqna', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class QuestionServiceTransport(abc.ABC): - """Abstract transport class for QuestionService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'dataqna.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes or self.AUTH_SCOPES - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.get_question: gapic_v1.method.wrap_method( - self.get_question, - default_timeout=None, - client_info=client_info, - ), - self.create_question: gapic_v1.method.wrap_method( - self.create_question, - default_timeout=60.0, - client_info=client_info, - ), - self.execute_question: gapic_v1.method.wrap_method( - self.execute_question, - default_timeout=60.0, - client_info=client_info, - ), - self.get_user_feedback: gapic_v1.method.wrap_method( - self.get_user_feedback, - default_timeout=None, - client_info=client_info, - ), - self.update_user_feedback: gapic_v1.method.wrap_method( - self.update_user_feedback, - default_timeout=60.0, - client_info=client_info, - ), - } - - @property - def get_question(self) -> Callable[ - [question_service.GetQuestionRequest], - Union[ - question.Question, - Awaitable[question.Question] - ]]: - raise NotImplementedError() - - @property - def create_question(self) -> Callable[ - [question_service.CreateQuestionRequest], - Union[ - gcd_question.Question, - Awaitable[gcd_question.Question] - ]]: - raise NotImplementedError() - - @property - def execute_question(self) -> Callable[ - [question_service.ExecuteQuestionRequest], - Union[ - question.Question, - Awaitable[question.Question] - ]]: - raise NotImplementedError() - - @property - def get_user_feedback(self) -> Callable[ - [question_service.GetUserFeedbackRequest], - Union[ - user_feedback.UserFeedback, - Awaitable[user_feedback.UserFeedback] - ]]: - raise NotImplementedError() - - @property - def update_user_feedback(self) -> Callable[ - [question_service.UpdateUserFeedbackRequest], - Union[ - gcd_user_feedback.UserFeedback, - Awaitable[gcd_user_feedback.UserFeedback] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'QuestionServiceTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py deleted file mode 100644 index 760bc88..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc.py +++ /dev/null @@ -1,374 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import gapic_v1 # type: ignore -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from .base import QuestionServiceTransport, DEFAULT_CLIENT_INFO - - -class QuestionServiceGrpcTransport(QuestionServiceTransport): - """gRPC backend transport for QuestionService. - - Service to interpret natural language queries. The service allows to - create ``Question`` resources that are interpreted and are filled - with one or more interpretations if the question could be - interpreted. Once a ``Question`` resource is created and has at - least one interpretation, an interpretation can be chosen for - execution, which triggers a query to the backend (for BigQuery, it - will create a job). Upon successful execution of that - interpretation, backend specific information will be returned so - that the client can retrieve the results from the backend. - - The ``Question`` resources are named - ``projects/*/locations/*/questions/*``. - - The ``Question`` resource has a singletion sub-resource - ``UserFeedback`` named - ``projects/*/locations/*/questions/*/userFeedback``, which allows - access to user feedback. - - 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 = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def get_question(self) -> Callable[ - [question_service.GetQuestionRequest], - question.Question]: - r"""Return a callable for the get question method over gRPC. - - Gets a previously created question. - - Returns: - Callable[[~.GetQuestionRequest], - ~.Question]: - 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_question' not in self._stubs: - self._stubs['get_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/GetQuestion', - request_serializer=question_service.GetQuestionRequest.serialize, - response_deserializer=question.Question.deserialize, - ) - return self._stubs['get_question'] - - @property - def create_question(self) -> Callable[ - [question_service.CreateQuestionRequest], - gcd_question.Question]: - r"""Return a callable for the create question method over gRPC. - - Creates a question. - - Returns: - Callable[[~.CreateQuestionRequest], - ~.Question]: - 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_question' not in self._stubs: - self._stubs['create_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/CreateQuestion', - request_serializer=question_service.CreateQuestionRequest.serialize, - response_deserializer=gcd_question.Question.deserialize, - ) - return self._stubs['create_question'] - - @property - def execute_question(self) -> Callable[ - [question_service.ExecuteQuestionRequest], - question.Question]: - r"""Return a callable for the execute question method over gRPC. - - Executes an interpretation. - - Returns: - Callable[[~.ExecuteQuestionRequest], - ~.Question]: - 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 'execute_question' not in self._stubs: - self._stubs['execute_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/ExecuteQuestion', - request_serializer=question_service.ExecuteQuestionRequest.serialize, - response_deserializer=question.Question.deserialize, - ) - return self._stubs['execute_question'] - - @property - def get_user_feedback(self) -> Callable[ - [question_service.GetUserFeedbackRequest], - user_feedback.UserFeedback]: - r"""Return a callable for the get user feedback method over gRPC. - - Gets previously created user feedback. - - Returns: - Callable[[~.GetUserFeedbackRequest], - ~.UserFeedback]: - 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_user_feedback' not in self._stubs: - self._stubs['get_user_feedback'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/GetUserFeedback', - request_serializer=question_service.GetUserFeedbackRequest.serialize, - response_deserializer=user_feedback.UserFeedback.deserialize, - ) - return self._stubs['get_user_feedback'] - - @property - def update_user_feedback(self) -> Callable[ - [question_service.UpdateUserFeedbackRequest], - gcd_user_feedback.UserFeedback]: - r"""Return a callable for the update user feedback method over gRPC. - - Updates user feedback. This creates user feedback if - there was none before (upsert). - - Returns: - Callable[[~.UpdateUserFeedbackRequest], - ~.UserFeedback]: - 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_user_feedback' not in self._stubs: - self._stubs['update_user_feedback'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/UpdateUserFeedback', - request_serializer=question_service.UpdateUserFeedbackRequest.serialize, - response_deserializer=gcd_user_feedback.UserFeedback.deserialize, - ) - return self._stubs['update_user_feedback'] - - -__all__ = ( - 'QuestionServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py deleted file mode 100644 index bc7174f..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/services/question_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,378 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from .base import QuestionServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import QuestionServiceGrpcTransport - - -class QuestionServiceGrpcAsyncIOTransport(QuestionServiceTransport): - """gRPC AsyncIO backend transport for QuestionService. - - Service to interpret natural language queries. The service allows to - create ``Question`` resources that are interpreted and are filled - with one or more interpretations if the question could be - interpreted. Once a ``Question`` resource is created and has at - least one interpretation, an interpretation can be chosen for - execution, which triggers a query to the backend (for BigQuery, it - will create a job). Upon successful execution of that - interpretation, backend specific information will be returned so - that the client can retrieve the results from the backend. - - The ``Question`` resources are named - ``projects/*/locations/*/questions/*``. - - The ``Question`` resource has a singletion sub-resource - ``UserFeedback`` named - ``projects/*/locations/*/questions/*/userFeedback``, which allows - access to user feedback. - - 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 = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'dataqna.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def get_question(self) -> Callable[ - [question_service.GetQuestionRequest], - Awaitable[question.Question]]: - r"""Return a callable for the get question method over gRPC. - - Gets a previously created question. - - Returns: - Callable[[~.GetQuestionRequest], - Awaitable[~.Question]]: - 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_question' not in self._stubs: - self._stubs['get_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/GetQuestion', - request_serializer=question_service.GetQuestionRequest.serialize, - response_deserializer=question.Question.deserialize, - ) - return self._stubs['get_question'] - - @property - def create_question(self) -> Callable[ - [question_service.CreateQuestionRequest], - Awaitable[gcd_question.Question]]: - r"""Return a callable for the create question method over gRPC. - - Creates a question. - - Returns: - Callable[[~.CreateQuestionRequest], - Awaitable[~.Question]]: - 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_question' not in self._stubs: - self._stubs['create_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/CreateQuestion', - request_serializer=question_service.CreateQuestionRequest.serialize, - response_deserializer=gcd_question.Question.deserialize, - ) - return self._stubs['create_question'] - - @property - def execute_question(self) -> Callable[ - [question_service.ExecuteQuestionRequest], - Awaitable[question.Question]]: - r"""Return a callable for the execute question method over gRPC. - - Executes an interpretation. - - Returns: - Callable[[~.ExecuteQuestionRequest], - Awaitable[~.Question]]: - 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 'execute_question' not in self._stubs: - self._stubs['execute_question'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/ExecuteQuestion', - request_serializer=question_service.ExecuteQuestionRequest.serialize, - response_deserializer=question.Question.deserialize, - ) - return self._stubs['execute_question'] - - @property - def get_user_feedback(self) -> Callable[ - [question_service.GetUserFeedbackRequest], - Awaitable[user_feedback.UserFeedback]]: - r"""Return a callable for the get user feedback method over gRPC. - - Gets previously created user feedback. - - Returns: - Callable[[~.GetUserFeedbackRequest], - Awaitable[~.UserFeedback]]: - 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_user_feedback' not in self._stubs: - self._stubs['get_user_feedback'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/GetUserFeedback', - request_serializer=question_service.GetUserFeedbackRequest.serialize, - response_deserializer=user_feedback.UserFeedback.deserialize, - ) - return self._stubs['get_user_feedback'] - - @property - def update_user_feedback(self) -> Callable[ - [question_service.UpdateUserFeedbackRequest], - Awaitable[gcd_user_feedback.UserFeedback]]: - r"""Return a callable for the update user feedback method over gRPC. - - Updates user feedback. This creates user feedback if - there was none before (upsert). - - Returns: - Callable[[~.UpdateUserFeedbackRequest], - Awaitable[~.UserFeedback]]: - 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_user_feedback' not in self._stubs: - self._stubs['update_user_feedback'] = self.grpc_channel.unary_unary( - '/google.cloud.dataqna.v1alpha.QuestionService/UpdateUserFeedback', - request_serializer=question_service.UpdateUserFeedbackRequest.serialize, - response_deserializer=gcd_user_feedback.UserFeedback.deserialize, - ) - return self._stubs['update_user_feedback'] - - -__all__ = ( - 'QuestionServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py deleted file mode 100644 index ee04af2..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/__init__.py +++ /dev/null @@ -1,72 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .annotated_string import ( - AnnotatedString, -) -from .auto_suggestion_service import ( - Suggestion, - SuggestionInfo, - SuggestQueriesRequest, - SuggestQueriesResponse, - SuggestionType, -) -from .question import ( - BigQueryJob, - DataQuery, - DebugFlags, - ExecutionInfo, - HumanReadable, - Interpretation, - InterpretationStructure, - InterpretError, - Question, - InterpretEntity, -) -from .question_service import ( - CreateQuestionRequest, - ExecuteQuestionRequest, - GetQuestionRequest, - GetUserFeedbackRequest, - UpdateUserFeedbackRequest, -) -from .user_feedback import ( - UserFeedback, -) - -__all__ = ( - 'AnnotatedString', - 'Suggestion', - 'SuggestionInfo', - 'SuggestQueriesRequest', - 'SuggestQueriesResponse', - 'SuggestionType', - 'BigQueryJob', - 'DataQuery', - 'DebugFlags', - 'ExecutionInfo', - 'HumanReadable', - 'Interpretation', - 'InterpretationStructure', - 'InterpretError', - 'Question', - 'InterpretEntity', - 'CreateQuestionRequest', - 'ExecuteQuestionRequest', - 'GetQuestionRequest', - 'GetUserFeedbackRequest', - 'UpdateUserFeedbackRequest', - 'UserFeedback', -) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py deleted file mode 100644 index b4d8378..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/annotated_string.py +++ /dev/null @@ -1,120 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.dataqna.v1alpha', - manifest={ - 'AnnotatedString', - }, -) - - -class AnnotatedString(proto.Message): - r"""Describes string annotation from both semantic and formatting - perspectives. Example: - - User Query: - - top countries by population in Africa - - 0 4 14 17 28 31 37 - - Table Data: - - - "country" - dimension - - "population" - metric - - "Africa" - value in the "continent" column - - text_formatted = ``"top countries by population in Africa"`` - - html_formatted = - ``"top countries by population in Africa"`` - - :: - - markups = [ - {DIMENSION, 4, 12}, // 'countries' - {METRIC, 17, 26}, // 'population' - {FILTER, 31, 36} // 'Africa' - ] - - Note that html formattings for 'DIMENSION' and 'METRIC' are the - same, while semantic markups are different. - - Attributes: - text_formatted (str): - Text version of the string. - html_formatted (str): - HTML version of the string annotation. - markups (Sequence[google.cloud.dataqna_v1alpha.types.AnnotatedString.SemanticMarkup]): - Semantic version of the string annotation. - """ - class SemanticMarkupType(proto.Enum): - r"""Semantic markup types.""" - MARKUP_TYPE_UNSPECIFIED = 0 - METRIC = 1 - DIMENSION = 2 - FILTER = 3 - UNUSED = 4 - BLOCKED = 5 - ROW = 6 - - class SemanticMarkup(proto.Message): - r"""Semantic markup denotes a substring (by index and length) - with markup information. - - Attributes: - type_ (google.cloud.dataqna_v1alpha.types.AnnotatedString.SemanticMarkupType): - The semantic type of the markup substring. - start_char_index (int): - Unicode character index of the query. - length (int): - The length (number of unicode characters) of - the markup substring. - """ - - type_ = proto.Field( - proto.ENUM, - number=1, - enum='AnnotatedString.SemanticMarkupType', - ) - start_char_index = proto.Field( - proto.INT32, - number=2, - ) - length = proto.Field( - proto.INT32, - number=3, - ) - - text_formatted = proto.Field( - proto.STRING, - number=1, - ) - html_formatted = proto.Field( - proto.STRING, - number=2, - ) - markups = proto.RepeatedField( - proto.MESSAGE, - number=3, - message=SemanticMarkup, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py deleted file mode 100644 index 717efc5..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/auto_suggestion_service.py +++ /dev/null @@ -1,199 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.cloud.dataqna_v1alpha.types import annotated_string - - -__protobuf__ = proto.module( - package='google.cloud.dataqna.v1alpha', - manifest={ - 'SuggestionType', - 'SuggestQueriesRequest', - 'Suggestion', - 'SuggestionInfo', - 'SuggestQueriesResponse', - }, -) - - -class SuggestionType(proto.Enum): - r"""The type of suggestion.""" - SUGGESTION_TYPE_UNSPECIFIED = 0 - ENTITY = 1 - TEMPLATE = 2 - - -class SuggestQueriesRequest(proto.Message): - r"""Request for query suggestions. - Attributes: - parent (str): - Required. The parent of the suggestion query - is the resource denoting the project and - location. - scopes (Sequence[str]): - The scopes to which this search is restricted. The only - supported scope pattern is - ``//bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}``. - query (str): - User query for which to generate suggestions. - If the query is empty, zero state suggestions - are returned. This allows UIs to display - suggestions right away, helping the user to get - a sense of what a query might look like. - suggestion_types (Sequence[google.cloud.dataqna_v1alpha.types.SuggestionType]): - The requested suggestion type. Multiple - suggestion types can be requested, but there is - no guarantee that the service will return - suggestions for each type. Suggestions for a - requested type might rank lower than suggestions - for other types and the service may decide to - cut these suggestions off. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - scopes = proto.RepeatedField( - proto.STRING, - number=2, - ) - query = proto.Field( - proto.STRING, - number=3, - ) - suggestion_types = proto.RepeatedField( - proto.ENUM, - number=4, - enum='SuggestionType', - ) - - -class Suggestion(proto.Message): - r"""A suggestion for a query with a ranking score. - Attributes: - suggestion_info (google.cloud.dataqna_v1alpha.types.SuggestionInfo): - Detailed information about the suggestion. - ranking_score (float): - The score of the suggestion. This can be used to define - ordering in UI. The score represents confidence in the - suggestion where higher is better. All score values must be - in the range [0, 1). - suggestion_type (google.cloud.dataqna_v1alpha.types.SuggestionType): - The type of the suggestion. - """ - - suggestion_info = proto.Field( - proto.MESSAGE, - number=1, - message='SuggestionInfo', - ) - ranking_score = proto.Field( - proto.DOUBLE, - number=2, - ) - suggestion_type = proto.Field( - proto.ENUM, - number=3, - enum='SuggestionType', - ) - - -class SuggestionInfo(proto.Message): - r"""Detailed information about the suggestion. - Attributes: - annotated_suggestion (google.cloud.dataqna_v1alpha.types.AnnotatedString): - Annotations for the suggestion. This provides - information about which part of the suggestion - corresponds to what semantic meaning (e.g. a - metric). - query_matches (Sequence[google.cloud.dataqna_v1alpha.types.SuggestionInfo.MatchInfo]): - Matches between user query and the annotated - string. - """ - - class MatchInfo(proto.Message): - r"""MatchInfo describes which part of suggestion matched with data in - user typed query. This can be used to highlight matching parts in - the UI. This is different from the annotations provided in - annotated_suggestion. The annotated_suggestion provides information - about the semantic meaning, while this provides information about - how it relates to the input. - - Example: user query: ``top products`` - - :: - - annotated_suggestion { - text_formatted = "top product_group" - html_formatted = "top product_group" - markups { - {type: TEXT, start_char_index: 0, length: 3} - {type: DIMENSION, start_char_index: 4, length: 13} - } - } - - query_matches { - { start_char_index: 0, length: 3 } - { start_char_index: 4, length: 7} - } - - Attributes: - start_char_index (int): - Unicode character index of the string - annotation. - length (int): - Count of unicode characters of this - substring. - """ - - start_char_index = proto.Field( - proto.INT32, - number=1, - ) - length = proto.Field( - proto.INT32, - number=2, - ) - - annotated_suggestion = proto.Field( - proto.MESSAGE, - number=1, - message=annotated_string.AnnotatedString, - ) - query_matches = proto.RepeatedField( - proto.MESSAGE, - number=2, - message=MatchInfo, - ) - - -class SuggestQueriesResponse(proto.Message): - r"""Response to SuggestQueries. - Attributes: - suggestions (Sequence[google.cloud.dataqna_v1alpha.types.Suggestion]): - A list of suggestions. - """ - - suggestions = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Suggestion', - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py deleted file mode 100644 index 4dd33be..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question.py +++ /dev/null @@ -1,593 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.cloud.dataqna_v1alpha.types import annotated_string -from google.protobuf import any_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.dataqna.v1alpha', - manifest={ - 'InterpretEntity', - 'Question', - 'InterpretError', - 'ExecutionInfo', - 'BigQueryJob', - 'Interpretation', - 'DataQuery', - 'HumanReadable', - 'InterpretationStructure', - 'DebugFlags', - }, -) - - -class InterpretEntity(proto.Enum): - r"""Query entities of an interpretation.""" - INTERPRET_ENTITY_UNSPECIFIED = 0 - DIMENSION = 1 - METRIC = 2 - - -class Question(proto.Message): - r"""The question resource represents a natural language query, - its settings, understanding generated by the system, and answer - retrieval status. A question cannot be modified. - - Attributes: - name (str): - Output only. Immutable. The unique identifier for the - Question. The ID is server-generated. Example: - ``projects/foo/locations/bar/questions/123`` - scopes (Sequence[str]): - Required. Immutable. Scopes to be used for the question. A - scope defines the relevant data set scope. It can be a - reference to a specific data source or a collection of data - sources. Currently, support is limited to a single BigQuery - table. There must be exactly one ``scopes`` element. - - Example: - ``//bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar`` - query (str): - Required. Immutable. The query in natural - language. - data_source_annotations (Sequence[str]): - A list of annotations to use instead of the - default annotation of a data source (set in the - data source reference resource). There must not - be more than one annotation with the same data - source reference. - interpret_error (google.cloud.dataqna_v1alpha.types.InterpretError): - An error field explaining why interpretation - failed. This is only populated if the - interpretation failed. - Note: This is different from getting a status - error on the request itself. This is not a - client or server error and the Question resource - is still persisted, but the service could not - interpret the question. Clients should present - the error to the user so the user can rephrase - the question. - interpretations (Sequence[google.cloud.dataqna_v1alpha.types.Interpretation]): - A list of interpretations for this question. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the question was created. - user_email (str): - Output only. The e-mail address of the user - that created this question. - debug_flags (google.cloud.dataqna_v1alpha.types.DebugFlags): - Input only. Immutable. Flags to request - additional information for debugging purposes. - debug_info (google.protobuf.any_pb2.Any): - Top level debug information. - This will be stored as the type - DebugInformation. Using Any so clients don't - need to pull in anything inside the debug - message. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - scopes = proto.RepeatedField( - proto.STRING, - number=2, - ) - query = proto.Field( - proto.STRING, - number=3, - ) - data_source_annotations = proto.RepeatedField( - proto.STRING, - number=4, - ) - interpret_error = proto.Field( - proto.MESSAGE, - number=5, - message='InterpretError', - ) - interpretations = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='Interpretation', - ) - create_time = proto.Field( - proto.MESSAGE, - number=7, - message=timestamp_pb2.Timestamp, - ) - user_email = proto.Field( - proto.STRING, - number=8, - ) - debug_flags = proto.Field( - proto.MESSAGE, - number=9, - message='DebugFlags', - ) - debug_info = proto.Field( - proto.MESSAGE, - number=10, - message=any_pb2.Any, - ) - - -class InterpretError(proto.Message): - r"""Details on the failure to interpret the question. - Attributes: - message (str): - Error message explaining why this question - could not be interpreted. - code (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretErrorCode): - The code for the error category why the - interpretation failed. - details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretErrorDetails): - Details on interpretation failure. - """ - class InterpretErrorCode(proto.Enum): - r"""The interpret error code provides an error category why the - interpretation failed. - """ - INTERPRET_ERROR_CODE_UNSPECIFIED = 0 - INVALID_QUERY = 1 - FAILED_TO_UNDERSTAND = 2 - FAILED_TO_ANSWER = 3 - - class InterpretErrorDetails(proto.Message): - r"""Details on interpretation failure. - Attributes: - unsupported_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretUnsupportedDetails): - Populated if parts of the query are - unsupported. - incomplete_query_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretIncompleteQueryDetails): - Populated if the query is incomplete. - ambiguity_details (google.cloud.dataqna_v1alpha.types.InterpretError.InterpretAmbiguityDetails): - Populated if the query was too ambiguous. - """ - - unsupported_details = proto.Field( - proto.MESSAGE, - number=1, - message='InterpretError.InterpretUnsupportedDetails', - ) - incomplete_query_details = proto.Field( - proto.MESSAGE, - number=2, - message='InterpretError.InterpretIncompleteQueryDetails', - ) - ambiguity_details = proto.Field( - proto.MESSAGE, - number=3, - message='InterpretError.InterpretAmbiguityDetails', - ) - - class InterpretUnsupportedDetails(proto.Message): - r"""Details about unsupported parts in a query. - Attributes: - operators (Sequence[str]): - Unsupported operators. For example: median. - intent (Sequence[str]): - Unsupported intents. - """ - - operators = proto.RepeatedField( - proto.STRING, - number=1, - ) - intent = proto.RepeatedField( - proto.STRING, - number=2, - ) - - class InterpretIncompleteQueryDetails(proto.Message): - r"""Details about an incomplete query. - Attributes: - entities (Sequence[google.cloud.dataqna_v1alpha.types.InterpretEntity]): - List of missing interpret entities. - """ - - entities = proto.RepeatedField( - proto.ENUM, - number=1, - enum='InterpretEntity', - ) - - class InterpretAmbiguityDetails(proto.Message): - r"""Details about a query that was too ambiguous. Currently, the - message has no fields and its presence signals that there was - ambiguity. - """ - - message = proto.Field( - proto.STRING, - number=1, - ) - code = proto.Field( - proto.ENUM, - number=2, - enum=InterpretErrorCode, - ) - details = proto.Field( - proto.MESSAGE, - number=3, - message=InterpretErrorDetails, - ) - - -class ExecutionInfo(proto.Message): - r"""Information about the backend status (such as BigQuery) of - the execution. - - Attributes: - job_creation_status (google.rpc.status_pb2.Status): - Status returned by the backend when the job - was created. - job_execution_state (google.cloud.dataqna_v1alpha.types.ExecutionInfo.JobExecutionState): - Status of the job execution. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the execution was triggered. - bigquery_job (google.cloud.dataqna_v1alpha.types.BigQueryJob): - BigQuery job information. - Future versions will have different backends. - Hence, clients must make sure they can handle it - when this field is not populated. - """ - class JobExecutionState(proto.Enum): - r"""Enum of possible job execution statuses.""" - JOB_EXECUTION_STATE_UNSPECIFIED = 0 - NOT_EXECUTED = 1 - RUNNING = 2 - SUCCEEDED = 3 - FAILED = 4 - - job_creation_status = proto.Field( - proto.MESSAGE, - number=1, - message=status_pb2.Status, - ) - job_execution_state = proto.Field( - proto.ENUM, - number=2, - enum=JobExecutionState, - ) - create_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - bigquery_job = proto.Field( - proto.MESSAGE, - number=4, - message='BigQueryJob', - ) - - -class BigQueryJob(proto.Message): - r"""BigQuery job information. This can be used to query the BigQuery API - and retrieve the current job's status (using - `jobs.get `__). - - Attributes: - job_id (str): - The job ID. - project_id (str): - The project ID of the job. - location (str): - The location where the job is running. - """ - - job_id = proto.Field( - proto.STRING, - number=1, - ) - project_id = proto.Field( - proto.STRING, - number=2, - ) - location = proto.Field( - proto.STRING, - number=3, - ) - - -class Interpretation(proto.Message): - r"""An interpretation of a natural language query. - Attributes: - data_sources (Sequence[str]): - List of data sources used in the current - understanding. - confidence (float): - The level of confidence that one of the interpretations is - correct. This is a value in the range [0, 1] where a value - of 0.5 or below is to be considered a low confidence. - unused_phrases (Sequence[str]): - A list of unused phrases. Clients should - display a Did You Mean (DYM) dialog if this is - non-empty, even if this is the only - interpretation. - human_readable (google.cloud.dataqna_v1alpha.types.HumanReadable): - Human readable representation of the query. - interpretation_structure (google.cloud.dataqna_v1alpha.types.InterpretationStructure): - Information about the interpretation - structure that helps to understand and visualize - the response. - data_query (google.cloud.dataqna_v1alpha.types.DataQuery): - Representation of the data query to be sent - to the backend. - execution_info (google.cloud.dataqna_v1alpha.types.ExecutionInfo): - Information about the backend response. This - is populated only if execution of an - interpretation was requested. - """ - - data_sources = proto.RepeatedField( - proto.STRING, - number=1, - ) - confidence = proto.Field( - proto.DOUBLE, - number=2, - ) - unused_phrases = proto.RepeatedField( - proto.STRING, - number=3, - ) - human_readable = proto.Field( - proto.MESSAGE, - number=4, - message='HumanReadable', - ) - interpretation_structure = proto.Field( - proto.MESSAGE, - number=5, - message='InterpretationStructure', - ) - data_query = proto.Field( - proto.MESSAGE, - number=6, - message='DataQuery', - ) - execution_info = proto.Field( - proto.MESSAGE, - number=7, - message='ExecutionInfo', - ) - - -class DataQuery(proto.Message): - r"""Representation of the data query for the backend. This is provided - for informational purposes only. Clients should not use it to send - it to the backend directly, but rather use the ``execute`` RPC to - trigger the execution. Using the ``execute`` RPC is needed in order - to track the state of a question and report on it correctly to the - data administrators. - - Attributes: - sql (str): - The generated SQL query to be sent to the - backend. - """ - - sql = proto.Field( - proto.STRING, - number=1, - ) - - -class HumanReadable(proto.Message): - r"""Human readable interpretation. - Attributes: - generated_interpretation (google.cloud.dataqna_v1alpha.types.AnnotatedString): - Generated query explaining the - interpretation. - original_question (google.cloud.dataqna_v1alpha.types.AnnotatedString): - Annotations on the original query. - """ - - generated_interpretation = proto.Field( - proto.MESSAGE, - number=1, - message=annotated_string.AnnotatedString, - ) - original_question = proto.Field( - proto.MESSAGE, - number=2, - message=annotated_string.AnnotatedString, - ) - - -class InterpretationStructure(proto.Message): - r"""Information about the interpretation structure that helps to - understand and visualize the response. - - Attributes: - visualization_types (Sequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.VisualizationType]): - List of possible visualization types to apply - for this interpretation. The order has no - relevance. - column_info (Sequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.ColumnInfo]): - Information about the output columns, that - is, the columns that will be returned by the - backend. - """ - class VisualizationType(proto.Enum): - r"""Enumeration of visualzation types to use for query response - data. - """ - VISUALIZATION_TYPE_UNSPECIFIED = 0 - TABLE = 1 - BAR_CHART = 2 - COLUMN_CHART = 3 - TIMELINE = 4 - SCATTER_PLOT = 5 - PIE_CHART = 6 - LINE_CHART = 7 - AREA_CHART = 8 - COMBO_CHART = 9 - HISTOGRAM = 10 - GENERIC_CHART = 11 - CHART_NOT_UNDERSTOOD = 12 - - class ColumnInfo(proto.Message): - r"""Information about a column. - Attributes: - output_alias (str): - The alias of the output column as used by the - backend. For example, the field name in the - schema provided in the query response in - BigQuery. - display_name (str): - Human readable name of the output column. - """ - - output_alias = proto.Field( - proto.STRING, - number=1, - ) - display_name = proto.Field( - proto.STRING, - number=2, - ) - - visualization_types = proto.RepeatedField( - proto.ENUM, - number=1, - enum=VisualizationType, - ) - column_info = proto.RepeatedField( - proto.MESSAGE, - number=2, - message=ColumnInfo, - ) - - -class DebugFlags(proto.Message): - r"""Configuriation of debug flags. - Attributes: - include_va_query (bool): - Whether to include the original VAQuery. - include_nested_va_query (bool): - Whether to include the original nested - VAQuery. - include_human_interpretation (bool): - Whether to include the original human - interpretation strings generated by Analyza. - include_aqua_debug_response (bool): - Whether to include the Aqua debug response. - time_override (int): - The time in milliseconds from Unix epoch to be used to - process the query. This is useful for testing the queries at - different time period. If not set or time_override <= 0, - then the current time is used. - is_internal_google_user (bool): - Set to true if request is initiated by an - internal Google user. - ignore_cache (bool): - Determines whether cache needs to be ignored. - If set to true, cache won't be queried and - updated. - include_search_entities_rpc (bool): - Whether to include the request/response pair - from the call to the EntityIndex for - SearchEntities. - include_list_column_annotations_rpc (bool): - Whether to include the request/response pair - from the call to the Annotations service for - ListColumnAnnotations. - include_virtual_analyst_entities (bool): - Whether to include the entity list passed to - Analyza. - include_table_list (bool): - Whether to include the table list. - include_domain_list (bool): - Whether to include the domain list. - """ - - include_va_query = proto.Field( - proto.BOOL, - number=1, - ) - include_nested_va_query = proto.Field( - proto.BOOL, - number=2, - ) - include_human_interpretation = proto.Field( - proto.BOOL, - number=3, - ) - include_aqua_debug_response = proto.Field( - proto.BOOL, - number=4, - ) - time_override = proto.Field( - proto.INT64, - number=5, - ) - is_internal_google_user = proto.Field( - proto.BOOL, - number=6, - ) - ignore_cache = proto.Field( - proto.BOOL, - number=7, - ) - include_search_entities_rpc = proto.Field( - proto.BOOL, - number=8, - ) - include_list_column_annotations_rpc = proto.Field( - proto.BOOL, - number=9, - ) - include_virtual_analyst_entities = proto.Field( - proto.BOOL, - number=10, - ) - include_table_list = proto.Field( - proto.BOOL, - number=11, - ) - include_domain_list = proto.Field( - proto.BOOL, - number=12, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py deleted file mode 100644 index b558a44..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/question_service.py +++ /dev/null @@ -1,138 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from google.protobuf import field_mask_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.dataqna.v1alpha', - manifest={ - 'GetQuestionRequest', - 'CreateQuestionRequest', - 'ExecuteQuestionRequest', - 'GetUserFeedbackRequest', - 'UpdateUserFeedbackRequest', - }, -) - - -class GetQuestionRequest(proto.Message): - r"""A request to get a previously created question. - Attributes: - name (str): - Required. The unique identifier for the question. Example: - ``projects/foo/locations/bar/questions/1234`` - read_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be retrieved. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - read_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class CreateQuestionRequest(proto.Message): - r"""Request to create a question resource. - Attributes: - parent (str): - Required. The name of the project this data source reference - belongs to. Example: ``projects/foo/locations/bar`` - question (google.cloud.dataqna_v1alpha.types.Question): - Required. The question to create. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - question = proto.Field( - proto.MESSAGE, - number=2, - message=gcd_question.Question, - ) - - -class ExecuteQuestionRequest(proto.Message): - r"""Request to execute an interpretation. - Attributes: - name (str): - Required. The unique identifier for the question. Example: - ``projects/foo/locations/bar/questions/1234`` - interpretation_index (int): - Required. Index of the interpretation to - execute. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - interpretation_index = proto.Field( - proto.INT32, - number=2, - ) - - -class GetUserFeedbackRequest(proto.Message): - r"""Request to get user feedback. - Attributes: - name (str): - Required. The unique identifier for the user feedback. User - feedback is a singleton resource on a Question. Example: - ``projects/foo/locations/bar/questions/1234/userFeedback`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateUserFeedbackRequest(proto.Message): - r"""Request to updates user feedback. - Attributes: - user_feedback (google.cloud.dataqna_v1alpha.types.UserFeedback): - Required. The user feedback to update. This - can be called even if there is no user feedback - so far. The feedback's name field is used to - identify the user feedback (and the - corresponding question) to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be updated. - """ - - user_feedback = proto.Field( - proto.MESSAGE, - number=1, - message=gcd_user_feedback.UserFeedback, - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py b/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py deleted file mode 100644 index c77abcf..0000000 --- a/owl-bot-staging/v1alpha/google/cloud/dataqna_v1alpha/types/user_feedback.py +++ /dev/null @@ -1,60 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.dataqna.v1alpha', - manifest={ - 'UserFeedback', - }, -) - - -class UserFeedback(proto.Message): - r"""Feedback provided by a user. - Attributes: - name (str): - Required. The unique identifier for the user feedback. User - feedback is a singleton resource on a Question. Example: - ``projects/foo/locations/bar/questions/1234/userFeedback`` - free_form_feedback (str): - Free form user feedback, such as a text box. - rating (google.cloud.dataqna_v1alpha.types.UserFeedback.UserFeedbackRating): - The user feedback rating - """ - class UserFeedbackRating(proto.Enum): - r"""Enumeration of feedback ratings.""" - USER_FEEDBACK_RATING_UNSPECIFIED = 0 - POSITIVE = 1 - NEGATIVE = 2 - - name = proto.Field( - proto.STRING, - number=1, - ) - free_form_feedback = proto.Field( - proto.STRING, - number=2, - ) - rating = proto.Field( - proto.ENUM, - number=3, - enum=UserFeedbackRating, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1alpha/mypy.ini b/owl-bot-staging/v1alpha/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1alpha/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1alpha/noxfile.py b/owl-bot-staging/v1alpha/noxfile.py deleted file mode 100644 index 8d47afa..0000000 --- a/owl-bot-staging/v1alpha/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/dataqna_v1alpha/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py b/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py deleted file mode 100644 index da5349a..0000000 --- a/owl-bot-staging/v1alpha/scripts/fixup_dataqna_v1alpha_keywords.py +++ /dev/null @@ -1,181 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class dataqnaCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_question': ('parent', 'question', ), - 'execute_question': ('name', 'interpretation_index', ), - 'get_question': ('name', 'read_mask', ), - 'get_user_feedback': ('name', ), - 'suggest_queries': ('parent', 'scopes', 'query', 'suggestion_types', ), - 'update_user_feedback': ('user_feedback', 'update_mask', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: not a.keyword.value in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=dataqnaCallTransformer(), -): - """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 dataqna 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/v1alpha/setup.py b/owl-bot-staging/v1alpha/setup.py deleted file mode 100644 index 1d7e204..0000000 --- a/owl-bot-staging/v1alpha/setup.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-dataqna', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1alpha/tests/__init__.py b/owl-bot-staging/v1alpha/tests/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1alpha/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1alpha/tests/unit/__init__.py b/owl-bot-staging/v1alpha/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1alpha/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py b/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1alpha/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py deleted file mode 100644 index 4dd158b..0000000 --- a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py +++ /dev/null @@ -1,1052 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import AutoSuggestionServiceAsyncClient -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import AutoSuggestionServiceClient -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import transports -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.dataqna_v1alpha.types import auto_suggestion_service -from google.oauth2 import service_account -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(None) is None - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert AutoSuggestionServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - AutoSuggestionServiceClient, - AutoSuggestionServiceAsyncClient, -]) -def test_auto_suggestion_service_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'dataqna.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - AutoSuggestionServiceClient, - AutoSuggestionServiceAsyncClient, -]) -def test_auto_suggestion_service_client_service_account_always_use_jwt(client_class): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_called_with(True) - - -@pytest.mark.parametrize("client_class", [ - AutoSuggestionServiceClient, - AutoSuggestionServiceAsyncClient, -]) -def test_auto_suggestion_service_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'dataqna.googleapis.com:443' - - -def test_auto_suggestion_service_client_get_transport_class(): - transport = AutoSuggestionServiceClient.get_transport_class() - available_transports = [ - transports.AutoSuggestionServiceGrpcTransport, - ] - assert transport in available_transports - - transport = AutoSuggestionServiceClient.get_transport_class("grpc") - assert transport == transports.AutoSuggestionServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), - (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(AutoSuggestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceClient)) -@mock.patch.object(AutoSuggestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceAsyncClient)) -def test_auto_suggestion_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(AutoSuggestionServiceClient, '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(AutoSuggestionServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc", "true"), - (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc", "false"), - (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(AutoSuggestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceClient)) -@mock.patch.object(AutoSuggestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AutoSuggestionServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_auto_suggestion_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), - (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_auto_suggestion_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AutoSuggestionServiceClient, transports.AutoSuggestionServiceGrpcTransport, "grpc"), - (AutoSuggestionServiceAsyncClient, transports.AutoSuggestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_auto_suggestion_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -def test_auto_suggestion_service_client_client_options_from_dict(): - with mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = AutoSuggestionServiceClient( - 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, - ) - - -def test_suggest_queries(transport: str = 'grpc', request_type=auto_suggestion_service.SuggestQueriesRequest): - client = AutoSuggestionServiceClient( - 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.suggest_queries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = auto_suggestion_service.SuggestQueriesResponse( - ) - response = client.suggest_queries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == auto_suggestion_service.SuggestQueriesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, auto_suggestion_service.SuggestQueriesResponse) - - -def test_suggest_queries_from_dict(): - test_suggest_queries(request_type=dict) - - -def test_suggest_queries_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 = AutoSuggestionServiceClient( - 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.suggest_queries), - '__call__') as call: - client.suggest_queries() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == auto_suggestion_service.SuggestQueriesRequest() - - -@pytest.mark.asyncio -async def test_suggest_queries_async(transport: str = 'grpc_asyncio', request_type=auto_suggestion_service.SuggestQueriesRequest): - client = AutoSuggestionServiceAsyncClient( - 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.suggest_queries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(auto_suggestion_service.SuggestQueriesResponse( - )) - response = await client.suggest_queries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == auto_suggestion_service.SuggestQueriesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, auto_suggestion_service.SuggestQueriesResponse) - - -@pytest.mark.asyncio -async def test_suggest_queries_async_from_dict(): - await test_suggest_queries_async(request_type=dict) - - -def test_suggest_queries_field_headers(): - client = AutoSuggestionServiceClient( - 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 = auto_suggestion_service.SuggestQueriesRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.suggest_queries), - '__call__') as call: - call.return_value = auto_suggestion_service.SuggestQueriesResponse() - client.suggest_queries(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_suggest_queries_field_headers_async(): - client = AutoSuggestionServiceAsyncClient( - 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 = auto_suggestion_service.SuggestQueriesRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.suggest_queries), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(auto_suggestion_service.SuggestQueriesResponse()) - await client.suggest_queries(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_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.AutoSuggestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AutoSuggestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.AutoSuggestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AutoSuggestionServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.AutoSuggestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AutoSuggestionServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.AutoSuggestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = AutoSuggestionServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.AutoSuggestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.AutoSuggestionServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.AutoSuggestionServiceGrpcTransport, - transports.AutoSuggestionServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = AutoSuggestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.AutoSuggestionServiceGrpcTransport, - ) - -def test_auto_suggestion_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.AutoSuggestionServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_auto_suggestion_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.AutoSuggestionServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'suggest_queries', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_auto_suggestion_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.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AutoSuggestionServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_auto_suggestion_service_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AutoSuggestionServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_auto_suggestion_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.dataqna_v1alpha.services.auto_suggestion_service.transports.AutoSuggestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AutoSuggestionServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_auto_suggestion_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) - AutoSuggestionServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_auto_suggestion_service_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - AutoSuggestionServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.AutoSuggestionServiceGrpcTransport, - transports.AutoSuggestionServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_auto_suggestion_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.AutoSuggestionServiceGrpcTransport, - transports.AutoSuggestionServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_auto_suggestion_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AutoSuggestionServiceGrpcTransport, grpc_helpers), - (transports.AutoSuggestionServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_auto_suggestion_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( - "dataqna.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="dataqna.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) -def test_auto_suggestion_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_auto_suggestion_service_host_no_port(): - client = AutoSuggestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com'), - ) - assert client.transport._host == 'dataqna.googleapis.com:443' - - -def test_auto_suggestion_service_host_with_port(): - client = AutoSuggestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com:8000'), - ) - assert client.transport._host == 'dataqna.googleapis.com:8000' - -def test_auto_suggestion_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AutoSuggestionServiceGrpcTransport( - 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_auto_suggestion_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AutoSuggestionServiceGrpcAsyncIOTransport( - 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.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) -def test_auto_suggestion_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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.AutoSuggestionServiceGrpcTransport, transports.AutoSuggestionServiceGrpcAsyncIOTransport]) -def test_auto_suggestion_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = AutoSuggestionServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = AutoSuggestionServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = AutoSuggestionServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = AutoSuggestionServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = AutoSuggestionServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = AutoSuggestionServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = AutoSuggestionServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = AutoSuggestionServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = AutoSuggestionServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = AutoSuggestionServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = AutoSuggestionServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = AutoSuggestionServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = AutoSuggestionServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = AutoSuggestionServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = AutoSuggestionServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.AutoSuggestionServiceTransport, '_prep_wrapped_messages') as prep: - client = AutoSuggestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.AutoSuggestionServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = AutoSuggestionServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py b/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py deleted file mode 100644 index 4553677..0000000 --- a/owl-bot-staging/v1alpha/tests/unit/gapic/dataqna_v1alpha/test_question_service.py +++ /dev/null @@ -1,2197 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.dataqna_v1alpha.services.question_service import QuestionServiceAsyncClient -from google.cloud.dataqna_v1alpha.services.question_service import QuestionServiceClient -from google.cloud.dataqna_v1alpha.services.question_service import transports -from google.cloud.dataqna_v1alpha.services.question_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.dataqna_v1alpha.types import annotated_string -from google.cloud.dataqna_v1alpha.types import question -from google.cloud.dataqna_v1alpha.types import question as gcd_question -from google.cloud.dataqna_v1alpha.types import question_service -from google.cloud.dataqna_v1alpha.types import user_feedback -from google.cloud.dataqna_v1alpha.types import user_feedback as gcd_user_feedback -from google.oauth2 import service_account -from google.protobuf import any_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert QuestionServiceClient._get_default_mtls_endpoint(None) is None - assert QuestionServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert QuestionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert QuestionServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert QuestionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert QuestionServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - QuestionServiceClient, - QuestionServiceAsyncClient, -]) -def test_question_service_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'dataqna.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - QuestionServiceClient, - QuestionServiceAsyncClient, -]) -def test_question_service_client_service_account_always_use_jwt(client_class): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_called_with(True) - - -@pytest.mark.parametrize("client_class", [ - QuestionServiceClient, - QuestionServiceAsyncClient, -]) -def test_question_service_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'dataqna.googleapis.com:443' - - -def test_question_service_client_get_transport_class(): - transport = QuestionServiceClient.get_transport_class() - available_transports = [ - transports.QuestionServiceGrpcTransport, - ] - assert transport in available_transports - - transport = QuestionServiceClient.get_transport_class("grpc") - assert transport == transports.QuestionServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), - (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(QuestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceClient)) -@mock.patch.object(QuestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceAsyncClient)) -def test_question_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(QuestionServiceClient, '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(QuestionServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc", "true"), - (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc", "false"), - (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(QuestionServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceClient)) -@mock.patch.object(QuestionServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(QuestionServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_question_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), - (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_question_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (QuestionServiceClient, transports.QuestionServiceGrpcTransport, "grpc"), - (QuestionServiceAsyncClient, transports.QuestionServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_question_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -def test_question_service_client_client_options_from_dict(): - with mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = QuestionServiceClient( - 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, - ) - - -def test_get_question(transport: str = 'grpc', request_type=question_service.GetQuestionRequest): - client = QuestionServiceClient( - 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_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - ) - response = client.get_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -def test_get_question_from_dict(): - test_get_question(request_type=dict) - - -def test_get_question_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 = QuestionServiceClient( - 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_question), - '__call__') as call: - client.get_question() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetQuestionRequest() - - -@pytest.mark.asyncio -async def test_get_question_async(transport: str = 'grpc_asyncio', request_type=question_service.GetQuestionRequest): - client = QuestionServiceAsyncClient( - 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_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - )) - response = await client.get_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -@pytest.mark.asyncio -async def test_get_question_async_from_dict(): - await test_get_question_async(request_type=dict) - - -def test_get_question_field_headers(): - client = QuestionServiceClient( - 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 = question_service.GetQuestionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_question), - '__call__') as call: - call.return_value = question.Question() - client.get_question(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_question_field_headers_async(): - client = QuestionServiceAsyncClient( - 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 = question_service.GetQuestionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_question), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) - await client.get_question(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_question_flattened(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_question( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_question_flattened_error(): - client = QuestionServiceClient( - 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_question( - question_service.GetQuestionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_question_flattened_async(): - client = QuestionServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_question( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_question_flattened_error_async(): - client = QuestionServiceAsyncClient( - 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_question( - question_service.GetQuestionRequest(), - name='name_value', - ) - - -def test_create_question(transport: str = 'grpc', request_type=question_service.CreateQuestionRequest): - client = QuestionServiceClient( - 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_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - ) - response = client.create_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.CreateQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcd_question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -def test_create_question_from_dict(): - test_create_question(request_type=dict) - - -def test_create_question_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 = QuestionServiceClient( - 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_question), - '__call__') as call: - client.create_question() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.CreateQuestionRequest() - - -@pytest.mark.asyncio -async def test_create_question_async(transport: str = 'grpc_asyncio', request_type=question_service.CreateQuestionRequest): - client = QuestionServiceAsyncClient( - 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_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - )) - response = await client.create_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.CreateQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcd_question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -@pytest.mark.asyncio -async def test_create_question_async_from_dict(): - await test_create_question_async(request_type=dict) - - -def test_create_question_field_headers(): - client = QuestionServiceClient( - 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 = question_service.CreateQuestionRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_question), - '__call__') as call: - call.return_value = gcd_question.Question() - client.create_question(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_question_field_headers_async(): - client = QuestionServiceAsyncClient( - 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 = question_service.CreateQuestionRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_question), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question()) - await client.create_question(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_question_flattened(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_question.Question() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_question( - parent='parent_value', - question=gcd_question.Question(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].question == gcd_question.Question(name='name_value') - - -def test_create_question_flattened_error(): - client = QuestionServiceClient( - 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_question( - question_service.CreateQuestionRequest(), - parent='parent_value', - question=gcd_question.Question(name='name_value'), - ) - - -@pytest.mark.asyncio -async def test_create_question_flattened_async(): - client = QuestionServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_question.Question() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_question.Question()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_question( - parent='parent_value', - question=gcd_question.Question(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].question == gcd_question.Question(name='name_value') - - -@pytest.mark.asyncio -async def test_create_question_flattened_error_async(): - client = QuestionServiceAsyncClient( - 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_question( - question_service.CreateQuestionRequest(), - parent='parent_value', - question=gcd_question.Question(name='name_value'), - ) - - -def test_execute_question(transport: str = 'grpc', request_type=question_service.ExecuteQuestionRequest): - client = QuestionServiceClient( - 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.execute_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - ) - response = client.execute_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.ExecuteQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -def test_execute_question_from_dict(): - test_execute_question(request_type=dict) - - -def test_execute_question_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 = QuestionServiceClient( - 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.execute_question), - '__call__') as call: - client.execute_question() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.ExecuteQuestionRequest() - - -@pytest.mark.asyncio -async def test_execute_question_async(transport: str = 'grpc_asyncio', request_type=question_service.ExecuteQuestionRequest): - client = QuestionServiceAsyncClient( - 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.execute_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(question.Question( - name='name_value', - scopes=['scopes_value'], - query='query_value', - data_source_annotations=['data_source_annotations_value'], - user_email='user_email_value', - )) - response = await client.execute_question(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.ExecuteQuestionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, question.Question) - assert response.name == 'name_value' - assert response.scopes == ['scopes_value'] - assert response.query == 'query_value' - assert response.data_source_annotations == ['data_source_annotations_value'] - assert response.user_email == 'user_email_value' - - -@pytest.mark.asyncio -async def test_execute_question_async_from_dict(): - await test_execute_question_async(request_type=dict) - - -def test_execute_question_field_headers(): - client = QuestionServiceClient( - 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 = question_service.ExecuteQuestionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.execute_question), - '__call__') as call: - call.return_value = question.Question() - client.execute_question(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_execute_question_field_headers_async(): - client = QuestionServiceAsyncClient( - 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 = question_service.ExecuteQuestionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.execute_question), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) - await client.execute_question(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_execute_question_flattened(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.execute_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.execute_question( - name='name_value', - interpretation_index=2159, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].interpretation_index == 2159 - - -def test_execute_question_flattened_error(): - client = QuestionServiceClient( - 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.execute_question( - question_service.ExecuteQuestionRequest(), - name='name_value', - interpretation_index=2159, - ) - - -@pytest.mark.asyncio -async def test_execute_question_flattened_async(): - client = QuestionServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.execute_question), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = question.Question() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(question.Question()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.execute_question( - name='name_value', - interpretation_index=2159, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].interpretation_index == 2159 - - -@pytest.mark.asyncio -async def test_execute_question_flattened_error_async(): - client = QuestionServiceAsyncClient( - 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.execute_question( - question_service.ExecuteQuestionRequest(), - name='name_value', - interpretation_index=2159, - ) - - -def test_get_user_feedback(transport: str = 'grpc', request_type=question_service.GetUserFeedbackRequest): - client = QuestionServiceClient( - 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_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = user_feedback.UserFeedback( - name='name_value', - free_form_feedback='free_form_feedback_value', - rating=user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, - ) - response = client.get_user_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetUserFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, user_feedback.UserFeedback) - assert response.name == 'name_value' - assert response.free_form_feedback == 'free_form_feedback_value' - assert response.rating == user_feedback.UserFeedback.UserFeedbackRating.POSITIVE - - -def test_get_user_feedback_from_dict(): - test_get_user_feedback(request_type=dict) - - -def test_get_user_feedback_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 = QuestionServiceClient( - 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_user_feedback), - '__call__') as call: - client.get_user_feedback() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetUserFeedbackRequest() - - -@pytest.mark.asyncio -async def test_get_user_feedback_async(transport: str = 'grpc_asyncio', request_type=question_service.GetUserFeedbackRequest): - client = QuestionServiceAsyncClient( - 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_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback( - name='name_value', - free_form_feedback='free_form_feedback_value', - rating=user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, - )) - response = await client.get_user_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.GetUserFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, user_feedback.UserFeedback) - assert response.name == 'name_value' - assert response.free_form_feedback == 'free_form_feedback_value' - assert response.rating == user_feedback.UserFeedback.UserFeedbackRating.POSITIVE - - -@pytest.mark.asyncio -async def test_get_user_feedback_async_from_dict(): - await test_get_user_feedback_async(request_type=dict) - - -def test_get_user_feedback_field_headers(): - client = QuestionServiceClient( - 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 = question_service.GetUserFeedbackRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_user_feedback), - '__call__') as call: - call.return_value = user_feedback.UserFeedback() - client.get_user_feedback(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_user_feedback_field_headers_async(): - client = QuestionServiceAsyncClient( - 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 = question_service.GetUserFeedbackRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_user_feedback), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback()) - await client.get_user_feedback(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_user_feedback_flattened(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = user_feedback.UserFeedback() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_user_feedback( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_user_feedback_flattened_error(): - client = QuestionServiceClient( - 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_user_feedback( - question_service.GetUserFeedbackRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_user_feedback_flattened_async(): - client = QuestionServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = user_feedback.UserFeedback() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(user_feedback.UserFeedback()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_user_feedback( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_user_feedback_flattened_error_async(): - client = QuestionServiceAsyncClient( - 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_user_feedback( - question_service.GetUserFeedbackRequest(), - name='name_value', - ) - - -def test_update_user_feedback(transport: str = 'grpc', request_type=question_service.UpdateUserFeedbackRequest): - client = QuestionServiceClient( - 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_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_user_feedback.UserFeedback( - name='name_value', - free_form_feedback='free_form_feedback_value', - rating=gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, - ) - response = client.update_user_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.UpdateUserFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcd_user_feedback.UserFeedback) - assert response.name == 'name_value' - assert response.free_form_feedback == 'free_form_feedback_value' - assert response.rating == gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE - - -def test_update_user_feedback_from_dict(): - test_update_user_feedback(request_type=dict) - - -def test_update_user_feedback_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 = QuestionServiceClient( - 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_user_feedback), - '__call__') as call: - client.update_user_feedback() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.UpdateUserFeedbackRequest() - - -@pytest.mark.asyncio -async def test_update_user_feedback_async(transport: str = 'grpc_asyncio', request_type=question_service.UpdateUserFeedbackRequest): - client = QuestionServiceAsyncClient( - 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_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback( - name='name_value', - free_form_feedback='free_form_feedback_value', - rating=gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE, - )) - response = await client.update_user_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == question_service.UpdateUserFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcd_user_feedback.UserFeedback) - assert response.name == 'name_value' - assert response.free_form_feedback == 'free_form_feedback_value' - assert response.rating == gcd_user_feedback.UserFeedback.UserFeedbackRating.POSITIVE - - -@pytest.mark.asyncio -async def test_update_user_feedback_async_from_dict(): - await test_update_user_feedback_async(request_type=dict) - - -def test_update_user_feedback_field_headers(): - client = QuestionServiceClient( - 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 = question_service.UpdateUserFeedbackRequest() - - request.user_feedback.name = 'user_feedback.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_user_feedback), - '__call__') as call: - call.return_value = gcd_user_feedback.UserFeedback() - client.update_user_feedback(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', - 'user_feedback.name=user_feedback.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_user_feedback_field_headers_async(): - client = QuestionServiceAsyncClient( - 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 = question_service.UpdateUserFeedbackRequest() - - request.user_feedback.name = 'user_feedback.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_user_feedback), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback()) - await client.update_user_feedback(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', - 'user_feedback.name=user_feedback.name/value', - ) in kw['metadata'] - - -def test_update_user_feedback_flattened(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_user_feedback.UserFeedback() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_user_feedback( - user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].user_feedback == gcd_user_feedback.UserFeedback(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_user_feedback_flattened_error(): - client = QuestionServiceClient( - 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_user_feedback( - question_service.UpdateUserFeedbackRequest(), - user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_user_feedback_flattened_async(): - client = QuestionServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_user_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcd_user_feedback.UserFeedback() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcd_user_feedback.UserFeedback()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_user_feedback( - user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].user_feedback == gcd_user_feedback.UserFeedback(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_user_feedback_flattened_error_async(): - client = QuestionServiceAsyncClient( - 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_user_feedback( - question_service.UpdateUserFeedbackRequest(), - user_feedback=gcd_user_feedback.UserFeedback(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.QuestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.QuestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = QuestionServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.QuestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = QuestionServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.QuestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = QuestionServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.QuestionServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.QuestionServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.QuestionServiceGrpcTransport, - transports.QuestionServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.QuestionServiceGrpcTransport, - ) - -def test_question_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.QuestionServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_question_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.QuestionServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'get_question', - 'create_question', - 'execute_question', - 'get_user_feedback', - 'update_user_feedback', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_question_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.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.QuestionServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_question_service_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.QuestionServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_question_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.dataqna_v1alpha.services.question_service.transports.QuestionServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.QuestionServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_question_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) - QuestionServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_question_service_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - QuestionServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.QuestionServiceGrpcTransport, - transports.QuestionServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_question_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.QuestionServiceGrpcTransport, - transports.QuestionServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_question_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.QuestionServiceGrpcTransport, grpc_helpers), - (transports.QuestionServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_question_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( - "dataqna.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="dataqna.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) -def test_question_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_question_service_host_no_port(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com'), - ) - assert client.transport._host == 'dataqna.googleapis.com:443' - - -def test_question_service_host_with_port(): - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='dataqna.googleapis.com:8000'), - ) - assert client.transport._host == 'dataqna.googleapis.com:8000' - -def test_question_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.QuestionServiceGrpcTransport( - 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_question_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.QuestionServiceGrpcAsyncIOTransport( - 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.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) -def test_question_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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.QuestionServiceGrpcTransport, transports.QuestionServiceGrpcAsyncIOTransport]) -def test_question_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_question_path(): - project = "squid" - location = "clam" - question = "whelk" - expected = "projects/{project}/locations/{location}/questions/{question}".format(project=project, location=location, question=question, ) - actual = QuestionServiceClient.question_path(project, location, question) - assert expected == actual - - -def test_parse_question_path(): - expected = { - "project": "octopus", - "location": "oyster", - "question": "nudibranch", - } - path = QuestionServiceClient.question_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_question_path(path) - assert expected == actual - -def test_user_feedback_path(): - project = "cuttlefish" - location = "mussel" - question = "winkle" - expected = "projects/{project}/locations/{location}/questions/{question}/userFeedback".format(project=project, location=location, question=question, ) - actual = QuestionServiceClient.user_feedback_path(project, location, question) - assert expected == actual - - -def test_parse_user_feedback_path(): - expected = { - "project": "nautilus", - "location": "scallop", - "question": "abalone", - } - path = QuestionServiceClient.user_feedback_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_user_feedback_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = QuestionServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = QuestionServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = QuestionServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = QuestionServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = QuestionServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = QuestionServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = QuestionServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = QuestionServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = QuestionServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = QuestionServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = QuestionServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.QuestionServiceTransport, '_prep_wrapped_messages') as prep: - client = QuestionServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.QuestionServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = QuestionServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py b/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py index daacdba..c5c5634 100644 --- a/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py +++ b/tests/unit/gapic/dataqna_v1alpha/test_auto_suggestion_service.py @@ -38,9 +38,6 @@ AutoSuggestionServiceClient, ) from google.cloud.dataqna_v1alpha.services.auto_suggestion_service import transports -from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.base import ( - _API_CORE_VERSION, -) from google.cloud.dataqna_v1alpha.services.auto_suggestion_service.transports.base import ( _GOOGLE_AUTH_VERSION, ) @@ -49,8 +46,9 @@ import google.auth -# TODO(busunkim): Once google-api-core >= 1.26.0 is required: -# - Delete all the api-core and auth "less than" test cases +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases # - Delete these pytest markers (Make the "greater than or equal to" tests the default). requires_google_auth_lt_1_25_0 = pytest.mark.skipif( packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), @@ -61,16 +59,6 @@ reason="This test requires google-auth >= 1.25.0", ) -requires_api_core_lt_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), - reason="This test requires google-api-core < 1.26.0", -) - -requires_api_core_gte_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), - reason="This test requires google-api-core >= 1.26.0", -) - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -134,6 +122,18 @@ def test_auto_suggestion_service_client_from_service_account_info(client_class): assert client.transport._host == "dataqna.googleapis.com:443" +@pytest.mark.parametrize( + "client_class", [AutoSuggestionServiceClient, AutoSuggestionServiceAsyncClient,] +) +def test_auto_suggestion_service_client_service_account_always_use_jwt(client_class): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + @pytest.mark.parametrize( "client_class", [AutoSuggestionServiceClient, AutoSuggestionServiceAsyncClient,] ) @@ -861,7 +861,6 @@ def test_auto_suggestion_service_transport_auth_adc_old_google_auth(transport_cl (transports.AutoSuggestionServiceGrpcAsyncIOTransport, grpc_helpers_async), ], ) -@requires_api_core_gte_1_26_0 def test_auto_suggestion_service_transport_create_channel( transport_class, grpc_helpers ): @@ -892,79 +891,6 @@ def test_auto_suggestion_service_transport_create_channel( ) -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AutoSuggestionServiceGrpcTransport, grpc_helpers), - (transports.AutoSuggestionServiceGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_auto_suggestion_service_transport_create_channel_old_api_core( - 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") - - create_channel.assert_called_with( - "dataqna.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AutoSuggestionServiceGrpcTransport, grpc_helpers), - (transports.AutoSuggestionServiceGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_auto_suggestion_service_transport_create_channel_user_scopes( - 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( - "dataqna.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=["1", "2"], - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - @pytest.mark.parametrize( "transport_class", [ diff --git a/tests/unit/gapic/dataqna_v1alpha/test_question_service.py b/tests/unit/gapic/dataqna_v1alpha/test_question_service.py index 34d4d3b..3a9323c 100644 --- a/tests/unit/gapic/dataqna_v1alpha/test_question_service.py +++ b/tests/unit/gapic/dataqna_v1alpha/test_question_service.py @@ -36,9 +36,6 @@ ) from google.cloud.dataqna_v1alpha.services.question_service import QuestionServiceClient from google.cloud.dataqna_v1alpha.services.question_service import transports -from google.cloud.dataqna_v1alpha.services.question_service.transports.base import ( - _API_CORE_VERSION, -) from google.cloud.dataqna_v1alpha.services.question_service.transports.base import ( _GOOGLE_AUTH_VERSION, ) @@ -56,8 +53,9 @@ import google.auth -# TODO(busunkim): Once google-api-core >= 1.26.0 is required: -# - Delete all the api-core and auth "less than" test cases +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases # - Delete these pytest markers (Make the "greater than or equal to" tests the default). requires_google_auth_lt_1_25_0 = pytest.mark.skipif( packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), @@ -68,16 +66,6 @@ reason="This test requires google-auth >= 1.25.0", ) -requires_api_core_lt_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), - reason="This test requires google-api-core < 1.26.0", -) - -requires_api_core_gte_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), - reason="This test requires google-api-core >= 1.26.0", -) - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -140,6 +128,18 @@ def test_question_service_client_from_service_account_info(client_class): assert client.transport._host == "dataqna.googleapis.com:443" +@pytest.mark.parametrize( + "client_class", [QuestionServiceClient, QuestionServiceAsyncClient,] +) +def test_question_service_client_service_account_always_use_jwt(client_class): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + @pytest.mark.parametrize( "client_class", [QuestionServiceClient, QuestionServiceAsyncClient,] ) @@ -1883,7 +1883,6 @@ def test_question_service_transport_auth_adc_old_google_auth(transport_class): (transports.QuestionServiceGrpcAsyncIOTransport, grpc_helpers_async), ], ) -@requires_api_core_gte_1_26_0 def test_question_service_transport_create_channel(transport_class, grpc_helpers): # If credentials and host are not provided, the transport class should use # ADC credentials. @@ -1912,79 +1911,6 @@ def test_question_service_transport_create_channel(transport_class, grpc_helpers ) -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.QuestionServiceGrpcTransport, grpc_helpers), - (transports.QuestionServiceGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_question_service_transport_create_channel_old_api_core( - 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") - - create_channel.assert_called_with( - "dataqna.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.QuestionServiceGrpcTransport, grpc_helpers), - (transports.QuestionServiceGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_question_service_transport_create_channel_user_scopes( - 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( - "dataqna.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=["1", "2"], - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - @pytest.mark.parametrize( "transport_class", [ From c056abc36259cbcf5ea6236f2affe1213288b0c2 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 22 Jun 2021 23:02:13 +0000 Subject: [PATCH 3/4] fix: require google-api-core>=1.26.0 --- setup.py | 2 +- testing/constraints-3.6.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 5a3635a..66d65c3 100644 --- a/setup.py +++ b/setup.py @@ -45,7 +45,7 @@ platforms="Posix; MacOS X; Windows", include_package_data=True, install_requires=( - "google-api-core[grpc] >= 1.22.2, < 2.0.0dev", + "google-api-core[grpc] >= 1.26.0, <2.0.0dev"," "proto-plus >= 1.10.0", "packaging >= 14.3", ), diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt index eb64cb3..3ba086c 100644 --- a/testing/constraints-3.6.txt +++ b/testing/constraints-3.6.txt @@ -5,6 +5,6 @@ # # e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev", # Then this file should have foo==1.14.0 -google-api-core==1.22.2 +google-api-core==1.26.0 proto-plus==1.10.0 packaging==14.3 From f41b51dac82895c4337f7e4ee4141da2e96ab400 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 22 Jun 2021 23:11:20 +0000 Subject: [PATCH 4/4] fix: fix typo in setup.py --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 66d65c3..5f7aa6f 100644 --- a/setup.py +++ b/setup.py @@ -45,7 +45,7 @@ platforms="Posix; MacOS X; Windows", include_package_data=True, install_requires=( - "google-api-core[grpc] >= 1.26.0, <2.0.0dev"," + "google-api-core[grpc] >= 1.26.0, <2.0.0dev", "proto-plus >= 1.10.0", "packaging >= 14.3", ),