diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 00000000..2a1c2d22 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/speech/__init__.py + google/cloud/speech/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 new file mode 100644 index 00000000..29227d4c --- /dev/null +++ b/owl-bot-staging/v1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 00000000..4a6fc4e7 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/speech *.py +recursive-include google/cloud/speech_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 00000000..36384b14 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Speech 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 Speech API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/_static/custom.css b/owl-bot-staging/v1/docs/_static/custom.css new file mode 100644 index 00000000..06423be0 --- /dev/null +++ b/owl-bot-staging/v1/docs/_static/custom.css @@ -0,0 +1,3 @@ +dl.field-list > dt { + min-width: 100px +} diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 00000000..3f5925bc --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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-speech documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-speech" +copyright = u"2023, 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 = 'en' + +# 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-speech-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-speech.tex", + u"google-cloud-speech Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-speech", + u"Google Cloud Speech Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-speech", + u"google-cloud-speech Documentation", + author, + "google-cloud-speech", + "GAPIC library for Google Cloud Speech API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 00000000..20c367af --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + speech_v1/services + speech_v1/types diff --git a/owl-bot-staging/v1/docs/speech_v1/adaptation.rst b/owl-bot-staging/v1/docs/speech_v1/adaptation.rst new file mode 100644 index 00000000..b87743e6 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/adaptation.rst @@ -0,0 +1,10 @@ +Adaptation +---------------------------- + +.. automodule:: google.cloud.speech_v1.services.adaptation + :members: + :inherited-members: + +.. automodule:: google.cloud.speech_v1.services.adaptation.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/speech_v1/services_.rst b/owl-bot-staging/v1/docs/speech_v1/services_.rst new file mode 100644 index 00000000..9d47b96f --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/services_.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Speech v1 API +======================================= +.. toctree:: + :maxdepth: 2 + + adaptation + speech diff --git a/owl-bot-staging/v1/docs/speech_v1/speech.rst b/owl-bot-staging/v1/docs/speech_v1/speech.rst new file mode 100644 index 00000000..53fc9d38 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/speech.rst @@ -0,0 +1,6 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v1.services.speech + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/speech_v1/types_.rst b/owl-bot-staging/v1/docs/speech_v1/types_.rst new file mode 100644 index 00000000..1f28fdd0 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Speech v1 API +==================================== + +.. automodule:: google.cloud.speech_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech/__init__.py new file mode 100644 index 00000000..36bd4b8d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech/__init__.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.speech_v1.services.adaptation.client import AdaptationClient +from google.cloud.speech_v1.services.adaptation.async_client import AdaptationAsyncClient +from google.cloud.speech_v1.services.speech.client import SpeechClient +from google.cloud.speech_v1.services.speech.async_client import SpeechAsyncClient + +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeMetadata +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import RecognitionAudio +from google.cloud.speech_v1.types.cloud_speech import RecognitionConfig +from google.cloud.speech_v1.types.cloud_speech import RecognitionMetadata +from google.cloud.speech_v1.types.cloud_speech import RecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import RecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import SpeakerDiarizationConfig +from google.cloud.speech_v1.types.cloud_speech import SpeechAdaptationInfo +from google.cloud.speech_v1.types.cloud_speech import SpeechContext +from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionAlternative +from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionResult +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionConfig +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionResult +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import TranscriptOutputConfig +from google.cloud.speech_v1.types.cloud_speech import WordInfo +from google.cloud.speech_v1.types.cloud_speech_adaptation import CreateCustomClassRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import CreatePhraseSetRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import DeleteCustomClassRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import DeletePhraseSetRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import GetCustomClassRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import GetPhraseSetRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import ListCustomClassesRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import ListCustomClassesResponse +from google.cloud.speech_v1.types.cloud_speech_adaptation import ListPhraseSetRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import ListPhraseSetResponse +from google.cloud.speech_v1.types.cloud_speech_adaptation import UpdateCustomClassRequest +from google.cloud.speech_v1.types.cloud_speech_adaptation import UpdatePhraseSetRequest +from google.cloud.speech_v1.types.resource import CustomClass +from google.cloud.speech_v1.types.resource import PhraseSet +from google.cloud.speech_v1.types.resource import SpeechAdaptation + +__all__ = ('AdaptationClient', + 'AdaptationAsyncClient', + 'SpeechClient', + 'SpeechAsyncClient', + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptationInfo', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', +) diff --git a/owl-bot-staging/v1/google/cloud/speech/gapic_version.py b/owl-bot-staging/v1/google/cloud/speech/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/speech/py.typed b/owl-bot-staging/v1/google/cloud/speech/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py new file mode 100644 index 00000000..c7e1c627 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py @@ -0,0 +1,100 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.adaptation import AdaptationClient +from .services.adaptation import AdaptationAsyncClient +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import LongRunningRecognizeMetadata +from .types.cloud_speech import LongRunningRecognizeRequest +from .types.cloud_speech import LongRunningRecognizeResponse +from .types.cloud_speech import RecognitionAudio +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionMetadata +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechAdaptationInfo +from .types.cloud_speech import SpeechContext +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import TranscriptOutputConfig +from .types.cloud_speech import WordInfo +from .types.cloud_speech_adaptation import CreateCustomClassRequest +from .types.cloud_speech_adaptation import CreatePhraseSetRequest +from .types.cloud_speech_adaptation import DeleteCustomClassRequest +from .types.cloud_speech_adaptation import DeletePhraseSetRequest +from .types.cloud_speech_adaptation import GetCustomClassRequest +from .types.cloud_speech_adaptation import GetPhraseSetRequest +from .types.cloud_speech_adaptation import ListCustomClassesRequest +from .types.cloud_speech_adaptation import ListCustomClassesResponse +from .types.cloud_speech_adaptation import ListPhraseSetRequest +from .types.cloud_speech_adaptation import ListPhraseSetResponse +from .types.cloud_speech_adaptation import UpdateCustomClassRequest +from .types.cloud_speech_adaptation import UpdatePhraseSetRequest +from .types.resource import CustomClass +from .types.resource import PhraseSet +from .types.resource import SpeechAdaptation + +__all__ = ( + 'AdaptationAsyncClient', + 'SpeechAsyncClient', +'AdaptationClient', +'CreateCustomClassRequest', +'CreatePhraseSetRequest', +'CustomClass', +'DeleteCustomClassRequest', +'DeletePhraseSetRequest', +'GetCustomClassRequest', +'GetPhraseSetRequest', +'ListCustomClassesRequest', +'ListCustomClassesResponse', +'ListPhraseSetRequest', +'ListPhraseSetResponse', +'LongRunningRecognizeMetadata', +'LongRunningRecognizeRequest', +'LongRunningRecognizeResponse', +'PhraseSet', +'RecognitionAudio', +'RecognitionConfig', +'RecognitionMetadata', +'RecognizeRequest', +'RecognizeResponse', +'SpeakerDiarizationConfig', +'SpeechAdaptation', +'SpeechAdaptationInfo', +'SpeechClient', +'SpeechContext', +'SpeechRecognitionAlternative', +'SpeechRecognitionResult', +'StreamingRecognitionConfig', +'StreamingRecognitionResult', +'StreamingRecognizeRequest', +'StreamingRecognizeResponse', +'TranscriptOutputConfig', +'UpdateCustomClassRequest', +'UpdatePhraseSetRequest', +'WordInfo', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json new file mode 100644 index 00000000..b2de8253 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json @@ -0,0 +1,242 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v1", + "protoPackage": "google.cloud.speech.v1", + "schema": "1.0", + "services": { + "Adaptation": { + "clients": { + "grpc": { + "libraryClient": "AdaptationClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AdaptationAsyncClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + }, + "rest": { + "libraryClient": "AdaptationClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + } + } + }, + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "rest": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/py.typed b/owl-bot-staging/v1/google/cloud/speech_v1/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py new file mode 100644 index 00000000..89a37dc9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/__init__.py new file mode 100644 index 00000000..e54a0bf0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 AdaptationClient +from .async_client import AdaptationAsyncClient + +__all__ = ( + 'AdaptationClient', + 'AdaptationAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/async_client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/async_client.py new file mode 100644 index 00000000..ce04a917 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/async_client.py @@ -0,0 +1,1491 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.speech_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.speech_v1.services.adaptation import pagers +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .client import AdaptationClient + + +class AdaptationAsyncClient: + """Service that implements Google Cloud Speech Adaptation API.""" + + _client: AdaptationClient + + DEFAULT_ENDPOINT = AdaptationClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AdaptationClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(AdaptationClient.custom_class_path) + parse_custom_class_path = staticmethod(AdaptationClient.parse_custom_class_path) + phrase_set_path = staticmethod(AdaptationClient.phrase_set_path) + parse_phrase_set_path = staticmethod(AdaptationClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(AdaptationClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(AdaptationClient.parse_common_billing_account_path) + common_folder_path = staticmethod(AdaptationClient.common_folder_path) + parse_common_folder_path = staticmethod(AdaptationClient.parse_common_folder_path) + common_organization_path = staticmethod(AdaptationClient.common_organization_path) + parse_common_organization_path = staticmethod(AdaptationClient.parse_common_organization_path) + common_project_path = staticmethod(AdaptationClient.common_project_path) + parse_common_project_path = staticmethod(AdaptationClient.parse_common_project_path) + common_location_path = staticmethod(AdaptationClient.common_location_path) + parse_common_location_path = staticmethod(AdaptationClient.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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_info.__func__(AdaptationAsyncClient, 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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_file.__func__(AdaptationAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return AdaptationClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(AdaptationClient).get_transport_class, type(AdaptationClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, AdaptationTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, ~.AdaptationTransport]): 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 = AdaptationClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[resource.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_create_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = await client.create_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + parent (:class:`str`): + Required. The parent resource where this phrase set will + be created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (:class:`google.cloud.speech_v1.types.PhraseSet`): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (:class:`str`): + Required. The ID to use for the + phrase set, which will become the final + component of the phrase set's resource + name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.CreatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_phrase_set, + 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 + + async def get_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_get_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + name (:class:`str`): + Required. The name of the phrase set to retrieve. + Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + 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.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.ListPhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetAsyncPager: + r"""List phrase sets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_list_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + parent (:class:`str`): + Required. The parent, which owns this collection of + phrase set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.services.adaptation.pagers.ListPhraseSetAsyncPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.ListPhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListPhraseSetAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[resource.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_update_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.UpdatePhraseSetRequest( + ) + + # Make the request + response = await client.update_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + phrase_set (:class:`google.cloud.speech_v1.types.PhraseSet`): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``phrase_set`` 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.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set, + 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(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_delete_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + await client.delete_phrase_set(request=request) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + name (:class:`str`): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.DeletePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_phrase_set, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def create_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[resource.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_create_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = await client.create_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + parent (:class:`str`): + Required. The parent resource where this custom class + will be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (:class:`google.cloud.speech_v1.types.CustomClass`): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (:class:`str`): + Required. The ID to use for the + custom class, which will become the + final component of the custom class' + resource name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.CreateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_custom_class, + 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 + + async def get_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_get_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + name (:class:`str`): + Required. The name of the custom class to retrieve. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + 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.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_custom_classes(self, + request: Optional[Union[cloud_speech_adaptation.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesAsyncPager: + r"""List custom classes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_list_custom_classes(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]]): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + parent (:class:`str`): + Required. The parent, which owns this collection of + custom classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.services.adaptation.pagers.ListCustomClassesAsyncPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.ListCustomClassesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_custom_classes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListCustomClassesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[resource.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_update_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.UpdateCustomClassRequest( + ) + + # Make the request + response = await client.update_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + custom_class (:class:`google.cloud.speech_v1.types.CustomClass`): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``custom_class`` 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.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 = cloud_speech_adaptation.UpdateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class, + 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(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_delete_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + await client.delete_custom_class(request=request) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + name (:class:`str`): + Required. The name of the custom class to delete. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.DeleteCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_custom_class, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + 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 __aenter__(self) -> "AdaptationAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AdaptationAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/client.py new file mode 100644 index 00000000..f98f2ad9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/client.py @@ -0,0 +1,1706 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.speech_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.speech_v1.services.adaptation import pagers +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import AdaptationGrpcTransport +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .transports.rest import AdaptationRestTransport + + +class AdaptationClientMeta(type): + """Metaclass for the Adaptation 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[AdaptationTransport]] + _transport_registry["grpc"] = AdaptationGrpcTransport + _transport_registry["grpc_asyncio"] = AdaptationGrpcAsyncIOTransport + _transport_registry["rest"] = AdaptationRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[AdaptationTransport]: + """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 AdaptationClient(metaclass=AdaptationClientMeta): + """Service that implements Google Cloud Speech Adaptation API.""" + + @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 = "speech.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: + AdaptationClient: 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: + AdaptationClient: 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) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, AdaptationTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, AdaptationTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, AdaptationTransport): + # transport is a AdaptationTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def create_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[resource.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_create_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = client.create_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + parent (str): + Required. The parent resource where this phrase set will + be created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (google.cloud.speech_v1.types.PhraseSet): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (str): + Required. The ID to use for the + phrase set, which will become the final + component of the phrase set's resource + name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.CreatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreatePhraseSetRequest): + request = cloud_speech_adaptation.CreatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] + + # 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 get_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_get_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + name (str): + Required. The name of the phrase set to retrieve. + Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + 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.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.GetPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetPhraseSetRequest): + request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.ListPhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetPager: + r"""List phrase sets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_list_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + parent (str): + Required. The parent, which owns this collection of + phrase set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.services.adaptation.pagers.ListPhraseSetPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.ListPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListPhraseSetRequest): + request = cloud_speech_adaptation.ListPhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListPhraseSetPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[resource.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_update_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.UpdatePhraseSetRequest( + ) + + # Make the request + response = client.update_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + phrase_set (google.cloud.speech_v1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``phrase_set`` 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.speech_v1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 cloud_speech_adaptation.UpdatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdatePhraseSetRequest): + request = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_delete_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + client.delete_phrase_set(request=request) + + Args: + request (Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + name (str): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.DeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeletePhraseSetRequest): + request = cloud_speech_adaptation.DeletePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def create_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[resource.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_create_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = client.create_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + parent (str): + Required. The parent resource where this custom class + will be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (google.cloud.speech_v1.types.CustomClass): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (str): + Required. The ID to use for the + custom class, which will become the + final component of the custom class' + resource name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.CreateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreateCustomClassRequest): + request = cloud_speech_adaptation.CreateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_custom_class] + + # 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 get_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_get_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + name (str): + Required. The name of the custom class to retrieve. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + 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.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.GetCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetCustomClassRequest): + request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_custom_classes(self, + request: Optional[Union[cloud_speech_adaptation.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesPager: + r"""List custom classes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_list_custom_classes(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + parent (str): + Required. The parent, which owns this collection of + custom classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1.services.adaptation.pagers.ListCustomClassesPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.ListCustomClassesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListCustomClassesRequest): + request = cloud_speech_adaptation.ListCustomClassesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_custom_classes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListCustomClassesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[resource.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_update_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.UpdateCustomClassRequest( + ) + + # Make the request + response = client.update_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + custom_class (google.cloud.speech_v1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``custom_class`` 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.speech_v1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 cloud_speech_adaptation.UpdateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdateCustomClassRequest): + request = cloud_speech_adaptation.UpdateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_delete_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + client.delete_custom_class(request=request) + + Args: + request (Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + name (str): + Required. The name of the custom class to delete. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.DeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeleteCustomClassRequest): + request = cloud_speech_adaptation.DeleteCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def __enter__(self) -> "AdaptationClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AdaptationClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/pagers.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/pagers.py new file mode 100644 index 00000000..2b71fdef --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/pagers.py @@ -0,0 +1,261 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource + + +class ListPhraseSetPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1.types.ListPhraseSetResponse` object, and + provides an ``__iter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1.types.ListPhraseSetResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech_adaptation.ListPhraseSetResponse], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1.types.ListPhraseSetResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech_adaptation.ListPhraseSetResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[resource.PhraseSet]: + for page in self.pages: + yield from page.phrase_sets + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListPhraseSetAsyncPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1.types.ListPhraseSetResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1.types.ListPhraseSetResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1.types.ListPhraseSetResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech_adaptation.ListPhraseSetResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[resource.PhraseSet]: + async def async_generator(): + async for page in self.pages: + for response in page.phrase_sets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1.types.ListCustomClassesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech_adaptation.ListCustomClassesResponse], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech_adaptation.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[resource.CustomClass]: + for page in self.pages: + yield from page.custom_classes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesAsyncPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1.types.ListCustomClassesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech_adaptation.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[resource.CustomClass]: + async def async_generator(): + async for page in self.pages: + for response in page.custom_classes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/__init__.py new file mode 100644 index 00000000..40a3b5b1 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 AdaptationTransport +from .grpc import AdaptationGrpcTransport +from .grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .rest import AdaptationRestTransport +from .rest import AdaptationRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[AdaptationTransport]] +_transport_registry['grpc'] = AdaptationGrpcTransport +_transport_registry['grpc_asyncio'] = AdaptationGrpcAsyncIOTransport +_transport_registry['rest'] = AdaptationRestTransport + +__all__ = ( + 'AdaptationTransport', + 'AdaptationGrpcTransport', + 'AdaptationGrpcAsyncIOTransport', + 'AdaptationRestTransport', + 'AdaptationRestInterceptor', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/base.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/base.py new file mode 100644 index 00000000..1a1f42cd --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/base.py @@ -0,0 +1,295 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.speech_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class AdaptationTransport(abc.ABC): + """Abstract transport class for Adaptation.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_phrase_set: gapic_v1.method.wrap_method( + self.create_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.get_phrase_set: gapic_v1.method.wrap_method( + self.get_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.list_phrase_set: gapic_v1.method.wrap_method( + self.list_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.update_phrase_set: gapic_v1.method.wrap_method( + self.update_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.delete_phrase_set: gapic_v1.method.wrap_method( + self.delete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.create_custom_class: gapic_v1.method.wrap_method( + self.create_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.get_custom_class: gapic_v1.method.wrap_method( + self.get_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.list_custom_classes: gapic_v1.method.wrap_method( + self.list_custom_classes, + default_timeout=None, + client_info=client_info, + ), + self.update_custom_class: gapic_v1.method.wrap_method( + self.update_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.delete_custom_class: gapic_v1.method.wrap_method( + self.delete_custom_class, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Union[ + cloud_speech_adaptation.ListPhraseSetResponse, + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse] + ]]: + raise NotImplementedError() + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Union[ + cloud_speech_adaptation.ListCustomClassesResponse, + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse] + ]]: + raise NotImplementedError() + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'AdaptationTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc.py new file mode 100644 index 00000000..803e3601 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc.py @@ -0,0 +1,540 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO + + +class AdaptationGrpcTransport(AdaptationTransport): + """gRPC backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + cloud_speech_adaptation.ListPhraseSetResponse]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + ~.ListPhraseSetResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + cloud_speech_adaptation.ListCustomClassesResponse]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + ~.ListCustomClassesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + def close(self): + self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'AdaptationGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc_asyncio.py new file mode 100644 index 00000000..224ea567 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/grpc_asyncio.py @@ -0,0 +1,539 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .grpc import AdaptationGrpcTransport + + +class AdaptationGrpcAsyncIOTransport(AdaptationTransport): + """gRPC AsyncIO backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + Awaitable[~.ListPhraseSetResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + Awaitable[~.ListCustomClassesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + def close(self): + return self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + +__all__ = ( + 'AdaptationGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/rest.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/rest.py new file mode 100644 index 00000000..4b580690 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/adaptation/transports/rest.py @@ -0,0 +1,1484 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.protobuf import empty_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore + +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class AdaptationRestInterceptor: + """Interceptor for Adaptation. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the AdaptationRestTransport. + + .. code-block:: python + class MyCustomAdaptationInterceptor(AdaptationRestInterceptor): + def pre_create_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_custom_classes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_custom_classes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + transport = AdaptationRestTransport(interceptor=MyCustomAdaptationInterceptor()) + client = AdaptationClient(transport=transport) + + + """ + def pre_create_custom_class(self, request: cloud_speech_adaptation.CreateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.CreateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_create_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_create_phrase_set(self, request: cloud_speech_adaptation.CreatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.CreatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_create_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_delete_custom_class(self, request: cloud_speech_adaptation.DeleteCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.DeleteCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def pre_delete_phrase_set(self, request: cloud_speech_adaptation.DeletePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.DeletePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def pre_get_custom_class(self, request: cloud_speech_adaptation.GetCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.GetCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_get_phrase_set(self, request: cloud_speech_adaptation.GetPhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.GetPhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_custom_classes(self, request: cloud_speech_adaptation.ListCustomClassesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.ListCustomClassesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_custom_classes(self, response: cloud_speech_adaptation.ListCustomClassesResponse) -> cloud_speech_adaptation.ListCustomClassesResponse: + """Post-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_phrase_set(self, request: cloud_speech_adaptation.ListPhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.ListPhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_phrase_set(self, response: cloud_speech_adaptation.ListPhraseSetResponse) -> cloud_speech_adaptation.ListPhraseSetResponse: + """Post-rpc interceptor for list_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_update_custom_class(self, request: cloud_speech_adaptation.UpdateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.UpdateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_update_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_update_phrase_set(self, request: cloud_speech_adaptation.UpdatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.UpdatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_update_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class AdaptationRestStub: + _session: AuthorizedSession + _host: str + _interceptor: AdaptationRestInterceptor + + +class AdaptationRestTransport(AdaptationTransport): + """REST backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[AdaptationRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or AdaptationRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("CreateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.CreateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the create custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.CreateCustomClassRequest): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/customClasses', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_create_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.CreateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_custom_class(resp) + return resp + + class _CreatePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("CreatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.CreatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the create phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.CreatePhraseSetRequest): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/phraseSets', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_create_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.CreatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_phrase_set(resp) + return resp + + class _DeleteCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("DeleteCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.DeleteCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.DeleteCustomClassRequest): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.DeleteCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeletePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("DeletePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.DeletePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.DeletePhraseSetRequest): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.DeletePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("GetCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.GetCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the get custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.GetCustomClassRequest): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_get_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.GetCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_custom_class(resp) + return resp + + class _GetPhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("GetPhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.GetPhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the get phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.GetPhraseSetRequest): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_get_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.GetPhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_phrase_set(resp) + return resp + + class _ListCustomClasses(AdaptationRestStub): + def __hash__(self): + return hash("ListCustomClasses") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.ListCustomClassesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech_adaptation.ListCustomClassesResponse: + r"""Call the list custom classes method over HTTP. + + Args: + request (~.cloud_speech_adaptation.ListCustomClassesRequest): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech_adaptation.ListCustomClassesResponse: + Message returned to the client by the + ``ListCustomClasses`` method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/customClasses', + }, + ] + request, metadata = self._interceptor.pre_list_custom_classes(request, metadata) + pb_request = cloud_speech_adaptation.ListCustomClassesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech_adaptation.ListCustomClassesResponse() + pb_resp = cloud_speech_adaptation.ListCustomClassesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_custom_classes(resp) + return resp + + class _ListPhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("ListPhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.ListPhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech_adaptation.ListPhraseSetResponse: + r"""Call the list phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.ListPhraseSetRequest): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech_adaptation.ListPhraseSetResponse: + Message returned to the client by the ``ListPhraseSet`` + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/phraseSets', + }, + ] + request, metadata = self._interceptor.pre_list_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.ListPhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech_adaptation.ListPhraseSetResponse() + pb_resp = cloud_speech_adaptation.ListPhraseSetResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_phrase_set(resp) + return resp + + class _UpdateCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("UpdateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.UpdateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the update custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.UpdateCustomClassRequest): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{custom_class.name=projects/*/locations/*/customClasses/*}', + 'body': 'custom_class', + }, + ] + request, metadata = self._interceptor.pre_update_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.UpdateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_custom_class(resp) + return resp + + class _UpdatePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("UpdatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.UpdatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the update phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.UpdatePhraseSetRequest): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{phrase_set.name=projects/*/locations/*/phraseSets/*}', + 'body': 'phrase_set', + }, + ] + request, metadata = self._interceptor.pre_update_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.UpdatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_phrase_set(resp) + return resp + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeletePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetPhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + cloud_speech_adaptation.ListCustomClassesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListCustomClasses(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + cloud_speech_adaptation.ListPhraseSetResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListPhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(AdaptationRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/operations/{name=**}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(AdaptationRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'AdaptationRestTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py new file mode 100644 index 00000000..0b9e4f6e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + 'SpeechClient', + 'SpeechAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py new file mode 100644 index 00000000..5b598c16 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py @@ -0,0 +1,717 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union + +from google.cloud.speech_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Service that implements Google Cloud Speech API.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(SpeechClient.custom_class_path) + parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) + phrase_set_path = staticmethod(SpeechClient.phrase_set_path) + parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return SpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.RecognizeRequest, dict]]): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def long_running_recognize(self, + request: Optional[Union[cloud_speech.LongRunningRecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_long_running_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]]): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.LongRunningRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.long_running_recognize, + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[AsyncIterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + async def sample_streaming_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + streaming_config = speech_v1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + + Args: + requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]): + The request object AsyncIterator. The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The + first message must contain a ``streaming_config`` + message and must not contain ``audio_content``. All + subsequent messages must contain ``audio_content`` and + must not contain a ``streaming_config`` message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + AsyncIterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + 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 __aenter__(self) -> "SpeechAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py new file mode 100644 index 00000000..fe71ce79 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py @@ -0,0 +1,914 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union, cast + +from google.cloud.speech_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .transports.rest import SpeechRestTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech 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[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + _transport_registry["rest"] = SpeechRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[SpeechTransport]: + """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 SpeechClient(metaclass=SpeechClientMeta): + """Service that implements Google Cloud Speech API.""" + + @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 = "speech.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: + SpeechClient: 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: + SpeechClient: 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) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, SpeechTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, SpeechTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.RecognizeRequest, dict]): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def long_running_recognize(self, + request: Optional[Union[cloud_speech.LongRunningRecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_long_running_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.LongRunningRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): + request = cloud_speech.LongRunningRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[Iterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1 + + def sample_streaming_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + streaming_config = speech_v1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + + Args: + requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]): + The request object iterator. The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The + first message must contain a ``streaming_config`` + message and must not contain ``audio_content``. All + subsequent messages must contain ``audio_content`` and + must not contain a ``streaming_config`` message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + Iterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "SpeechClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py new file mode 100644 index 00000000..4bac8f03 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport +from .rest import SpeechRestTransport +from .rest import SpeechRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry['grpc'] = SpeechGrpcTransport +_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport +_transport_registry['rest'] = SpeechRestTransport + +__all__ = ( + 'SpeechTransport', + 'SpeechGrpcTransport', + 'SpeechGrpcAsyncIOTransport', + 'SpeechRestTransport', + 'SpeechRestInterceptor', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py new file mode 100644 index 00000000..77e4ab71 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py @@ -0,0 +1,215 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.speech_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + self.long_running_recognize: gapic_v1.method.wrap_method( + self.long_running_recognize, + default_timeout=5000.0, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, + Awaitable[cloud_speech.RecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'SpeechTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py new file mode 100644 index 00000000..64e88604 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py @@ -0,0 +1,379 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Service that implements Google Cloud Speech API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + def close(self): + self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'SpeechGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py new file mode 100644 index 00000000..b65d3693 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,378 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Service that implements Google Cloud Speech API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Awaitable[cloud_speech.RecognizeResponse]]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse]]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + def close(self): + return self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + +__all__ = ( + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/rest.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/rest.py new file mode 100644 index 00000000..a1d2fb12 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/rest.py @@ -0,0 +1,655 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +from .base import SpeechTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class SpeechRestInterceptor: + """Interceptor for Speech. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the SpeechRestTransport. + + .. code-block:: python + class MyCustomSpeechInterceptor(SpeechRestInterceptor): + def pre_long_running_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_long_running_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + transport = SpeechRestTransport(interceptor=MyCustomSpeechInterceptor()) + client = SpeechClient(transport=transport) + + + """ + def pre_long_running_recognize(self, request: cloud_speech.LongRunningRecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.LongRunningRecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for long_running_recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_long_running_recognize(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for long_running_recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_recognize(self, request: cloud_speech.RecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.RecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_recognize(self, response: cloud_speech.RecognizeResponse) -> cloud_speech.RecognizeResponse: + """Post-rpc interceptor for recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class SpeechRestStub: + _session: AuthorizedSession + _host: str + _interceptor: SpeechRestInterceptor + + +class SpeechRestTransport(SpeechTransport): + """REST backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[SpeechRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or SpeechRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v1/operations/{name=**}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v1/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _LongRunningRecognize(SpeechRestStub): + def __hash__(self): + return hash("LongRunningRecognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.LongRunningRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the long running recognize method over HTTP. + + Args: + request (~.cloud_speech.LongRunningRecognizeRequest): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/speech:longrunningrecognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_long_running_recognize(request, metadata) + pb_request = cloud_speech.LongRunningRecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_long_running_recognize(resp) + return resp + + class _Recognize(SpeechRestStub): + def __hash__(self): + return hash("Recognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.RecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.RecognizeResponse: + r"""Call the recognize method over HTTP. + + Args: + request (~.cloud_speech.RecognizeRequest): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.RecognizeResponse: + The only message returned to the client by the + ``Recognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/speech:recognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_recognize(request, metadata) + pb_request = cloud_speech.RecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.RecognizeResponse() + pb_resp = cloud_speech.RecognizeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_recognize(resp) + return resp + + class _StreamingRecognize(SpeechRestStub): + def __hash__(self): + return hash("StreamingRecognize") + + def __call__(self, + request: cloud_speech.StreamingRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> rest_streaming.ResponseIterator: + raise NotImplementedError( + "Method StreamingRecognize is not available over REST transport" + ) + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._LongRunningRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._Recognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._StreamingRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(SpeechRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/operations/{name=**}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(SpeechRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'SpeechRestTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py new file mode 100644 index 00000000..0c567808 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py @@ -0,0 +1,92 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .cloud_speech import ( + LongRunningRecognizeMetadata, + LongRunningRecognizeRequest, + LongRunningRecognizeResponse, + RecognitionAudio, + RecognitionConfig, + RecognitionMetadata, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechAdaptationInfo, + SpeechContext, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + TranscriptOutputConfig, + WordInfo, +) +from .cloud_speech_adaptation import ( + CreateCustomClassRequest, + CreatePhraseSetRequest, + DeleteCustomClassRequest, + DeletePhraseSetRequest, + GetCustomClassRequest, + GetPhraseSetRequest, + ListCustomClassesRequest, + ListCustomClassesResponse, + ListPhraseSetRequest, + ListPhraseSetResponse, + UpdateCustomClassRequest, + UpdatePhraseSetRequest, +) +from .resource import ( + CustomClass, + PhraseSet, + SpeechAdaptation, +) + +__all__ = ( + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptationInfo', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py new file mode 100644 index 00000000..e0e4fcdf --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py @@ -0,0 +1,1521 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.cloud.speech_v1.types import resource +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1', + manifest={ + 'RecognizeRequest', + 'LongRunningRecognizeRequest', + 'TranscriptOutputConfig', + 'StreamingRecognizeRequest', + 'StreamingRecognitionConfig', + 'RecognitionConfig', + 'SpeakerDiarizationConfig', + 'RecognitionMetadata', + 'SpeechContext', + 'RecognitionAudio', + 'RecognizeResponse', + 'LongRunningRecognizeResponse', + 'LongRunningRecognizeMetadata', + 'StreamingRecognizeResponse', + 'StreamingRecognitionResult', + 'SpeechRecognitionResult', + 'SpeechRecognitionAlternative', + 'WordInfo', + 'SpeechAdaptationInfo', + }, +) + + +class RecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the ``Recognize`` + method. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be recognized. + """ + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio: 'RecognitionAudio' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + + +class LongRunningRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``LongRunningRecognize`` method. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be recognized. + output_config (google.cloud.speech_v1.types.TranscriptOutputConfig): + Optional. Specifies an optional destination + for the recognition results. + """ + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio: 'RecognitionAudio' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + output_config: 'TranscriptOutputConfig' = proto.Field( + proto.MESSAGE, + number=4, + message='TranscriptOutputConfig', + ) + + +class TranscriptOutputConfig(proto.Message): + r"""Specifies an optional destination for the recognition + results. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + gcs_uri (str): + Specifies a Cloud Storage URI for the recognition results. + Must be specified in the format: + ``gs://bucket_name/object_name``, and the bucket must + already exist. + + This field is a member of `oneof`_ ``output_type``. + """ + + gcs_uri: str = proto.Field( + proto.STRING, + number=1, + oneof='output_type', + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The first message + must contain a ``streaming_config`` message and must not contain + ``audio_content``. All subsequent messages must contain + ``audio_content`` and must not contain a ``streaming_config`` + message. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + streaming_config (google.cloud.speech_v1.types.StreamingRecognitionConfig): + Provides information to the recognizer that specifies how to + process the request. The first ``StreamingRecognizeRequest`` + message must contain a ``streaming_config`` message. + + This field is a member of `oneof`_ ``streaming_request``. + audio_content (bytes): + The audio data to be recognized. Sequential chunks of audio + data are sent in sequential ``StreamingRecognizeRequest`` + messages. The first ``StreamingRecognizeRequest`` message + must not contain ``audio_content`` data and all subsequent + ``StreamingRecognizeRequest`` messages must contain + ``audio_content`` data. The audio bytes must be encoded as + specified in ``RecognitionConfig``. Note: as with all bytes + fields, proto buffers use a pure binary representation (not + base64). See `content + limits `__. + + This field is a member of `oneof`_ ``streaming_request``. + """ + + streaming_config: 'StreamingRecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + oneof='streaming_request', + message='StreamingRecognitionConfig', + ) + audio_content: bytes = proto.Field( + proto.BYTES, + number=2, + oneof='streaming_request', + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + single_utterance (bool): + If ``false`` or omitted, the recognizer will perform + continuous recognition (continuing to wait for and process + audio even if the user pauses speaking) until the client + closes the input stream (gRPC API) or until the maximum time + limit has been reached. May return multiple + ``StreamingRecognitionResult``\ s with the ``is_final`` flag + set to ``true``. + + If ``true``, the recognizer will detect a single spoken + utterance. When it detects that the user has paused or + stopped speaking, it will return an + ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It + will return no more than one ``StreamingRecognitionResult`` + with the ``is_final`` flag set to ``true``. + + The ``single_utterance`` field can only be used with + specified models, otherwise an error is thrown. The + ``model`` field in [``RecognitionConfig``][] must be set to: + + - ``command_and_search`` + - ``phone_call`` AND additional field + ``useEnhanced``\ =\ ``true`` + - The ``model`` field is left undefined. In this case the + API auto-selects a model based on any other parameters + that you set in ``RecognitionConfig``. + interim_results (bool): + If ``true``, interim results (tentative hypotheses) may be + returned as they become available (these interim results are + indicated with the ``is_final=false`` flag). If ``false`` or + omitted, only ``is_final=true`` result(s) are returned. + enable_voice_activity_events (bool): + If ``true``, responses with voice activity speech events + will be returned as they are detected. + voice_activity_timeout (google.cloud.speech_v1.types.StreamingRecognitionConfig.VoiceActivityTimeout): + If set, the server will automatically close the stream after + the specified duration has elapsed after the last + VOICE_ACTIVITY speech event has been sent. The field + ``voice_activity_events`` must also be set to true. + """ + + class VoiceActivityTimeout(proto.Message): + r"""Events that a timeout can be set on for voice activity. + + Attributes: + speech_start_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream if no speech + begins. + speech_end_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream after speech + ends. + """ + + speech_start_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + speech_end_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + single_utterance: bool = proto.Field( + proto.BOOL, + number=2, + ) + interim_results: bool = proto.Field( + proto.BOOL, + number=3, + ) + enable_voice_activity_events: bool = proto.Field( + proto.BOOL, + number=5, + ) + voice_activity_timeout: VoiceActivityTimeout = proto.Field( + proto.MESSAGE, + number=6, + message=VoiceActivityTimeout, + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + encoding (google.cloud.speech_v1.types.RecognitionConfig.AudioEncoding): + Encoding of audio data sent in all ``RecognitionAudio`` + messages. This field is optional for ``FLAC`` and ``WAV`` + audio files and required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent in all + ``RecognitionAudio`` messages. Valid values are: 8000-48000. + 16000 is optimal. For best results, set the sampling rate of + the audio source to 16000 Hz. If that's not possible, use + the native sample rate of the audio source (instead of + re-sampling). This field is optional for FLAC and WAV audio + files, but is required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. + audio_channel_count (int): + The number of channels in the input audio data. ONLY set + this for MULTI-CHANNEL recognition. Valid values for + LINEAR16, OGG_OPUS and FLAC are ``1``-``8``. Valid value for + MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only ``1``. + If ``0`` or omitted, defaults to one channel (mono). Note: + We only recognize the first channel by default. To perform + independent recognition on each channel set + ``enable_separate_recognition_per_channel`` to 'true'. + enable_separate_recognition_per_channel (bool): + This needs to be set to ``true`` explicitly and + ``audio_channel_count`` > 1 to get each channel recognized + separately. The recognition result will contain a + ``channel_tag`` field to state which channel that result + belongs to. If this is not true, we will only recognize the + first channel. The request is billed cumulatively for all + channels recognized: ``audio_channel_count`` multiplied by + the length of the audio. + language_code (str): + Required. The language of the supplied audio as a + `BCP-47 `__ + language tag. Example: "en-US". See `Language + Support `__ + for a list of the currently supported language codes. + alternative_language_codes (MutableSequence[str]): + A list of up to 3 additional + `BCP-47 `__ + language tags, listing possible alternative languages of the + supplied audio. See `Language + Support `__ + for a list of the currently supported language codes. If + alternative languages are listed, recognition result will + contain recognition in the most likely language detected + including the main language_code. The recognition result + will include the language tag of the language detected in + the audio. Note: This feature is only supported for Voice + Command and Voice Search use cases and performance may vary + for other use cases (e.g., phone call transcription). + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. + Specifically, the maximum number of + ``SpeechRecognitionAlternative`` messages within each + ``SpeechRecognitionResult``. The server may return fewer + than ``max_alternatives``. Valid values are ``0``-``30``. A + value of ``0`` or ``1`` will return a maximum of one. If + omitted, will return a maximum of one. + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, e.g. "f***". If set to + ``false`` or omitted, profanities won't be filtered out. + adaptation (google.cloud.speech_v1.types.SpeechAdaptation): + Speech adaptation configuration improves the accuracy of + speech recognition. For more information, see the `speech + adaptation `__ + documentation. When speech adaptation is set it supersedes + the ``speech_contexts`` field. + speech_contexts (MutableSequence[google.cloud.speech_v1.types.SpeechContext]): + Array of + [SpeechContext][google.cloud.speech.v1.SpeechContext]. A + means to provide context to assist the speech recognition. + For more information, see `speech + adaptation `__. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_word_confidence (bool): + If ``true``, the top result includes a list of words and the + confidence for those words. If ``false``, no word-level + confidence information is returned. The default is + ``false``. + enable_automatic_punctuation (bool): + If 'true', adds punctuation to recognition + result hypotheses. This feature is only + available in select languages. Setting this for + requests in other languages has no effect at + all. The default 'false' value does not add + punctuation to result hypotheses. + enable_spoken_punctuation (google.protobuf.wrappers_pb2.BoolValue): + The spoken punctuation behavior for the call If not set, + uses default behavior based on model of choice e.g. + command_and_search will enable spoken punctuation by default + If 'true', replaces spoken punctuation with the + corresponding symbols in the request. For example, "how are + you question mark" becomes "how are you?". See + https://cloud.google.com/speech-to-text/docs/spoken-punctuation + for support. If 'false', spoken punctuation is not replaced. + enable_spoken_emojis (google.protobuf.wrappers_pb2.BoolValue): + The spoken emoji behavior for the call + If not set, uses default behavior based on model + of choice If 'true', adds spoken emoji + formatting for the request. This will replace + spoken emojis with the corresponding Unicode + symbols in the final transcript. If 'false', + spoken emojis are not replaced. + diarization_config (google.cloud.speech_v1.types.SpeakerDiarizationConfig): + Config to enable speaker diarization and set + additional parameters to make diarization better + suited for your application. Note: When this is + enabled, we send all the words from the + beginning of the audio for the top alternative + in every consecutive STREAMING responses. This + is done in order to improve our speaker tags as + our models learn to identify the speakers in the + conversation over time. For non-streaming + requests, the diarization results will be + provided only in the top alternative of the + FINAL SpeechRecognitionResult. + metadata (google.cloud.speech_v1.types.RecognitionMetadata): + Metadata regarding this request. + model (str): + Which model to select for the given request. Select the + model best suited to your domain to get best results. If a + model is not explicitly specified, then we auto-select a + model based on the parameters in the RecognitionConfig. + + .. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModelDescription
latest_longBest for long form content like media or conversation.
latest_shortBest for short form content like commands or single shot directed + speech.
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically + recorded at an 8khz sampling rate).
videoBest for audio that originated from video or includes multiple + speakers. Ideally the audio is recorded at a 16khz or greater + sampling rate. This is a premium model that costs more than the + standard rate.
defaultBest for audio that is not one of the specific audio models. + For example, long-form audio. Ideally the audio is high-fidelity, + recorded at a 16khz or greater sampling rate.
medical_conversationBest for audio that originated from a conversation between a + medical provider and patient.
medical_dictationBest for audio that originated from dictation notes by a medical + provider.
+ use_enhanced (bool): + Set to true to use an enhanced model for speech recognition. + If ``use_enhanced`` is set to true and the ``model`` field + is not set, then an appropriate enhanced model is chosen if + an enhanced model exists for the audio. + + If ``use_enhanced`` is true and an enhanced version of the + specified model does not exist, then the speech is + recognized using the standard version of the specified + model. + """ + class AudioEncoding(proto.Enum): + r"""The encoding of the audio data sent in the request. + + All encodings support only 1 channel (mono) audio, unless the + ``audio_channel_count`` and + ``enable_separate_recognition_per_channel`` fields are set. + + For best results, the audio source should be captured and + transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). + The accuracy of the speech recognition can be reduced if lossy + codecs are used to capture or transmit audio, particularly if + background noise is present. Lossy codecs include ``MULAW``, + ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, + ``MP3``, and ``WEBM_OPUS``. + + The ``FLAC`` and ``WAV`` audio file formats include a header that + describes the included audio content. You can request recognition + for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` + encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in + your request, you do not need to specify an ``AudioEncoding``; the + audio encoding format is determined from the file header. If you + specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` + audio, the encoding configuration must match the encoding described + in the audio header; otherwise the request returns an + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] + error code. + + Values: + ENCODING_UNSPECIFIED (0): + Not specified. + LINEAR16 (1): + Uncompressed 16-bit signed little-endian + samples (Linear PCM). + FLAC (2): + ``FLAC`` (Free Lossless Audio Codec) is the recommended + encoding because it is lossless--therefore recognition is + not compromised--and requires only about half the bandwidth + of ``LINEAR16``. ``FLAC`` stream encoding supports 16-bit + and 24-bit samples, however, not all fields in + ``STREAMINFO`` are supported. + MULAW (3): + 8-bit samples that compand 14-bit audio + samples using G.711 PCMU/mu-law. + AMR (4): + Adaptive Multi-Rate Narrowband codec. ``sample_rate_hertz`` + must be 8000. + AMR_WB (5): + Adaptive Multi-Rate Wideband codec. ``sample_rate_hertz`` + must be 16000. + OGG_OPUS (6): + Opus encoded audio frames in Ogg container + (`OggOpus `__). + ``sample_rate_hertz`` must be one of 8000, 12000, 16000, + 24000, or 48000. + SPEEX_WITH_HEADER_BYTE (7): + Although the use of lossy encodings is not recommended, if a + very low bitrate encoding is required, ``OGG_OPUS`` is + highly preferred over Speex encoding. The + `Speex `__ encoding supported by Cloud + Speech API has a header byte in each block, as in MIME type + ``audio/x-speex-with-header-byte``. It is a variant of the + RTP Speex encoding defined in `RFC + 5574 `__. The stream is + a sequence of blocks, one block per RTP packet. Each block + starts with a byte containing the length of the block, in + bytes, followed by one or more frames of Speex data, padded + to an integral number of bytes (octets) as specified in RFC + 5574. In other words, each RTP header is replaced with a + single byte containing the block length. Only Speex wideband + is supported. ``sample_rate_hertz`` must be 16000. + WEBM_OPUS (9): + Opus encoded audio frames in WebM container + (`OggOpus `__). + ``sample_rate_hertz`` must be one of 8000, 12000, 16000, + 24000, or 48000. + """ + ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + FLAC = 2 + MULAW = 3 + AMR = 4 + AMR_WB = 5 + OGG_OPUS = 6 + SPEEX_WITH_HEADER_BYTE = 7 + WEBM_OPUS = 9 + + encoding: AudioEncoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz: int = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count: int = proto.Field( + proto.INT32, + number=7, + ) + enable_separate_recognition_per_channel: bool = proto.Field( + proto.BOOL, + number=12, + ) + language_code: str = proto.Field( + proto.STRING, + number=3, + ) + alternative_language_codes: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=18, + ) + max_alternatives: int = proto.Field( + proto.INT32, + number=4, + ) + profanity_filter: bool = proto.Field( + proto.BOOL, + number=5, + ) + adaptation: resource.SpeechAdaptation = proto.Field( + proto.MESSAGE, + number=20, + message=resource.SpeechAdaptation, + ) + speech_contexts: MutableSequence['SpeechContext'] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='SpeechContext', + ) + enable_word_time_offsets: bool = proto.Field( + proto.BOOL, + number=8, + ) + enable_word_confidence: bool = proto.Field( + proto.BOOL, + number=15, + ) + enable_automatic_punctuation: bool = proto.Field( + proto.BOOL, + number=11, + ) + enable_spoken_punctuation: wrappers_pb2.BoolValue = proto.Field( + proto.MESSAGE, + number=22, + message=wrappers_pb2.BoolValue, + ) + enable_spoken_emojis: wrappers_pb2.BoolValue = proto.Field( + proto.MESSAGE, + number=23, + message=wrappers_pb2.BoolValue, + ) + diarization_config: 'SpeakerDiarizationConfig' = proto.Field( + proto.MESSAGE, + number=19, + message='SpeakerDiarizationConfig', + ) + metadata: 'RecognitionMetadata' = proto.Field( + proto.MESSAGE, + number=9, + message='RecognitionMetadata', + ) + model: str = proto.Field( + proto.STRING, + number=13, + ) + use_enhanced: bool = proto.Field( + proto.BOOL, + number=14, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Config to enable speaker diarization. + + Attributes: + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. + min_speaker_count (int): + Minimum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 2. + max_speaker_count (int): + Maximum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 6. + speaker_tag (int): + Output only. Unused. + """ + + enable_speaker_diarization: bool = proto.Field( + proto.BOOL, + number=1, + ) + min_speaker_count: int = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count: int = proto.Field( + proto.INT32, + number=3, + ) + speaker_tag: int = proto.Field( + proto.INT32, + number=5, + ) + + +class RecognitionMetadata(proto.Message): + r"""Description of audio data to be recognized. + + Attributes: + interaction_type (google.cloud.speech_v1.types.RecognitionMetadata.InteractionType): + The use case most closely describing the + audio content to be recognized. + industry_naics_code_of_audio (int): + The industry vertical to which this speech + recognition request most closely applies. This + is most indicative of the topics contained in + the audio. Use the 6-digit NAICS code to + identify the industry vertical - see + https://www.naics.com/search/. + microphone_distance (google.cloud.speech_v1.types.RecognitionMetadata.MicrophoneDistance): + The audio type that most closely describes + the audio being recognized. + original_media_type (google.cloud.speech_v1.types.RecognitionMetadata.OriginalMediaType): + The original media the speech was recorded + on. + recording_device_type (google.cloud.speech_v1.types.RecognitionMetadata.RecordingDeviceType): + The type of device the speech was recorded + with. + recording_device_name (str): + The device used to make the recording. + Examples 'Nexus 5X' or 'Polycom SoundStation IP + 6000' or 'POTS' or 'VoIP' or 'Cardioid + Microphone'. + original_mime_type (str): + Mime type of the original audio file. For example + ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, + ``audio/3gpp``. A list of possible audio mime types is + maintained at + http://www.iana.org/assignments/media-types/media-types.xhtml#audio + audio_topic (str): + Description of the content. Eg. "Recordings + of federal supreme court hearings from 2012". + """ + class InteractionType(proto.Enum): + r"""Use case categories that the audio recognition request can be + described by. + + Values: + INTERACTION_TYPE_UNSPECIFIED (0): + Use case is either unknown or is something + other than one of the other values below. + DISCUSSION (1): + Multiple people in a conversation or discussion. For example + in a meeting with two or more people actively participating. + Typically all the primary people speaking would be in the + same room (if not, see PHONE_CALL) + PRESENTATION (2): + One or more persons lecturing or presenting + to others, mostly uninterrupted. + PHONE_CALL (3): + A phone-call or video-conference in which two + or more people, who are not in the same room, + are actively participating. + VOICEMAIL (4): + A recorded message intended for another + person to listen to. + PROFESSIONALLY_PRODUCED (5): + Professionally produced audio (eg. TV Show, + Podcast). + VOICE_SEARCH (6): + Transcribe spoken questions and queries into + text. + VOICE_COMMAND (7): + Transcribe voice commands, such as for + controlling a device. + DICTATION (8): + Transcribe speech to text to create a written + document, such as a text-message, email or + report. + """ + INTERACTION_TYPE_UNSPECIFIED = 0 + DISCUSSION = 1 + PRESENTATION = 2 + PHONE_CALL = 3 + VOICEMAIL = 4 + PROFESSIONALLY_PRODUCED = 5 + VOICE_SEARCH = 6 + VOICE_COMMAND = 7 + DICTATION = 8 + + class MicrophoneDistance(proto.Enum): + r"""Enumerates the types of capture settings describing an audio + file. + + Values: + MICROPHONE_DISTANCE_UNSPECIFIED (0): + Audio type is not known. + NEARFIELD (1): + The audio was captured from a closely placed + microphone. Eg. phone, dictaphone, or handheld + microphone. Generally if there speaker is within + 1 meter of the microphone. + MIDFIELD (2): + The speaker if within 3 meters of the + microphone. + FARFIELD (3): + The speaker is more than 3 meters away from + the microphone. + """ + MICROPHONE_DISTANCE_UNSPECIFIED = 0 + NEARFIELD = 1 + MIDFIELD = 2 + FARFIELD = 3 + + class OriginalMediaType(proto.Enum): + r"""The original media the speech was recorded on. + + Values: + ORIGINAL_MEDIA_TYPE_UNSPECIFIED (0): + Unknown original media type. + AUDIO (1): + The speech data is an audio recording. + VIDEO (2): + The speech data originally recorded on a + video. + """ + ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 + AUDIO = 1 + VIDEO = 2 + + class RecordingDeviceType(proto.Enum): + r"""The type of device the speech was recorded with. + + Values: + RECORDING_DEVICE_TYPE_UNSPECIFIED (0): + The recording device is unknown. + SMARTPHONE (1): + Speech was recorded on a smartphone. + PC (2): + Speech was recorded using a personal computer + or tablet. + PHONE_LINE (3): + Speech was recorded over a phone line. + VEHICLE (4): + Speech was recorded in a vehicle. + OTHER_OUTDOOR_DEVICE (5): + Speech was recorded outdoors. + OTHER_INDOOR_DEVICE (6): + Speech was recorded indoors. + """ + RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 + SMARTPHONE = 1 + PC = 2 + PHONE_LINE = 3 + VEHICLE = 4 + OTHER_OUTDOOR_DEVICE = 5 + OTHER_INDOOR_DEVICE = 6 + + interaction_type: InteractionType = proto.Field( + proto.ENUM, + number=1, + enum=InteractionType, + ) + industry_naics_code_of_audio: int = proto.Field( + proto.UINT32, + number=3, + ) + microphone_distance: MicrophoneDistance = proto.Field( + proto.ENUM, + number=4, + enum=MicrophoneDistance, + ) + original_media_type: OriginalMediaType = proto.Field( + proto.ENUM, + number=5, + enum=OriginalMediaType, + ) + recording_device_type: RecordingDeviceType = proto.Field( + proto.ENUM, + number=6, + enum=RecordingDeviceType, + ) + recording_device_name: str = proto.Field( + proto.STRING, + number=7, + ) + original_mime_type: str = proto.Field( + proto.STRING, + number=8, + ) + audio_topic: str = proto.Field( + proto.STRING, + number=10, + ) + + +class SpeechContext(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + phrases (MutableSequence[str]): + A list of strings containing words and phrases "hints" so + that the speech recognition is more likely to recognize + them. This can be used to improve the accuracy for specific + words and phrases, for example, if specific commands are + typically spoken by the user. This can also be used to add + additional words to the vocabulary of the recognizer. See + `usage + limits `__. + + List items can also be set to classes for groups of words + that represent common concepts that occur in natural + language. For example, rather than providing phrase hints + for every month of the year, using the $MONTH class improves + the likelihood of correctly transcribing audio that includes + months. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. + """ + + phrases: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + boost: float = proto.Field( + proto.FLOAT, + number=4, + ) + + +class RecognitionAudio(proto.Message): + r"""Contains audio data in the encoding specified in the + ``RecognitionConfig``. Either ``content`` or ``uri`` must be + supplied. Supplying both or neither returns + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + content (bytes): + The audio data bytes encoded as specified in + ``RecognitionConfig``. Note: as with all bytes fields, proto + buffers use a pure binary representation, whereas JSON + representations use base64. + + This field is a member of `oneof`_ ``audio_source``. + uri (str): + URI that points to a file that contains audio data bytes as + specified in ``RecognitionConfig``. The file must not be + compressed (for example, gzip). Currently, only Google Cloud + Storage URIs are supported, which must be specified in the + following format: ``gs://bucket_name/object_name`` (other + URI formats return + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + + This field is a member of `oneof`_ ``audio_source``. + """ + + content: bytes = proto.Field( + proto.BYTES, + number=1, + oneof='audio_source', + ) + uri: str = proto.Field( + proto.STRING, + number=2, + oneof='audio_source', + ) + + +class RecognizeResponse(proto.Message): + r"""The only message returned to the client by the ``Recognize`` method. + It contains the result as zero or more sequential + ``SpeechRecognitionResult`` messages. + + Attributes: + results (MutableSequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + speech_adaptation_info (google.cloud.speech_v1.types.SpeechAdaptationInfo): + Provides information on adaptation behavior + in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=3, + message=duration_pb2.Duration, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=7, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=8, + ) + + +class LongRunningRecognizeResponse(proto.Message): + r"""The only message returned to the client by the + ``LongRunningRecognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. It is included + in the ``result.response`` field of the ``Operation`` returned by + the ``GetOperation`` call of the ``google::longrunning::Operations`` + service. + + Attributes: + results (MutableSequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + output_config (google.cloud.speech_v1.types.TranscriptOutputConfig): + Original output config if present in the + request. + output_error (google.rpc.status_pb2.Status): + If the transcript output fails this field + contains the relevant error. + speech_adaptation_info (google.cloud.speech_v1.types.SpeechAdaptationInfo): + Provides information on speech adaptation + behavior in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=3, + message=duration_pb2.Duration, + ) + output_config: 'TranscriptOutputConfig' = proto.Field( + proto.MESSAGE, + number=6, + message='TranscriptOutputConfig', + ) + output_error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=7, + message=status_pb2.Status, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=8, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=9, + ) + + +class LongRunningRecognizeMetadata(proto.Message): + r"""Describes the progress of a long-running ``LongRunningRecognize`` + call. It is included in the ``metadata`` field of the ``Operation`` + returned by the ``GetOperation`` call of the + ``google::longrunning::Operations`` service. + + Attributes: + progress_percent (int): + Approximate percentage of audio processed + thus far. Guaranteed to be 100 when the audio is + fully processed and the results are available. + start_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the request was received. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time of the most recent processing update. + uri (str): + Output only. The URI of the audio file being + transcribed. Empty if the audio was sent as byte + content. + """ + + progress_percent: int = proto.Field( + proto.INT32, + number=1, + ) + start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + last_update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + uri: str = proto.Field( + proto.STRING, + number=4, + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``StreamingRecognizeResponse`` is the only message returned to the + client by ``StreamingRecognize``. A series of zero or more + ``StreamingRecognizeResponse`` messages are streamed back to the + client. If there is no recognizable audio, and ``single_utterance`` + is set to false, then no messages are streamed back to the client. + + Here's an example of a series of ``StreamingRecognizeResponse``\ s + that might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. results { alternatives { transcript: " that is the question" + confidence: 0.98 } alternatives { transcript: " that was the + question" } is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain final results; + they are indicated by ``is_final: true``. Concatenating these + together generates the full transcript: "to be or not to be that + is the question". + + - The others contain interim ``results``. #3 and #6 contain two + interim ``results``: the first portion has a high stability and + is less likely to change; the second portion has a low stability + and is very likely to change. A UI designer might choose to show + only high stability ``results``. + + - The specific ``stability`` and ``confidence`` values shown above + are only for illustrative purposes. Actual values may vary. + + - In each response, only one of these fields will be set: + ``error``, ``speech_event_type``, or one or more (repeated) + ``results``. + + Attributes: + error (google.rpc.status_pb2.Status): + If set, returns a [google.rpc.Status][google.rpc.Status] + message that specifies the error for the operation. + results (MutableSequence[google.cloud.speech_v1.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one ``is_final=true`` + result (the newly settled portion), followed by zero or more + ``is_final=false`` results (the interim results). + speech_event_type (google.cloud.speech_v1.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + speech_event_time (google.protobuf.duration_pb2.Duration): + Time offset between the beginning of the + audio and event emission. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + stream. Set only if this is the last response in + the stream. + speech_adaptation_info (google.cloud.speech_v1.types.SpeechAdaptationInfo): + Provides information on adaptation behavior + in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event. + + Values: + SPEECH_EVENT_UNSPECIFIED (0): + No speech event specified. + END_OF_SINGLE_UTTERANCE (1): + This event indicates that the server has detected the end of + the user's speech utterance and expects no additional + speech. Therefore, the server will not process additional + audio (although it may subsequently return additional + results). The client should stop sending additional audio + data, half-close the gRPC connection, and wait for any + additional results until the server closes the gRPC + connection. This event is only sent if ``single_utterance`` + was set to ``true``, and is not used otherwise. + SPEECH_ACTIVITY_BEGIN (2): + This event indicates that the server has detected the + beginning of human voice activity in the stream. This event + can be returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + SPEECH_ACTIVITY_END (3): + This event indicates that the server has detected the end of + human voice activity in the stream. This event can be + returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + SPEECH_ACTIVITY_TIMEOUT (4): + This event indicates that the user-set + timeout for speech activity begin or end has + exceeded. Upon receiving this event, the client + is expected to send a half close. Further audio + will not be processed. + """ + SPEECH_EVENT_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + SPEECH_ACTIVITY_BEGIN = 2 + SPEECH_ACTIVITY_END = 3 + SPEECH_ACTIVITY_TIMEOUT = 4 + + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + results: MutableSequence['StreamingRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='StreamingRecognitionResult', + ) + speech_event_type: SpeechEventType = proto.Field( + proto.ENUM, + number=4, + enum=SpeechEventType, + ) + speech_event_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=8, + message=duration_pb2.Duration, + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=5, + message=duration_pb2.Duration, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=9, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=10, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + is_final (bool): + If ``false``, this ``StreamingRecognitionResult`` represents + an interim result that may change. If ``true``, this is the + final time the speech service will return this particular + ``StreamingRecognitionResult``, the recognizer will not + return any further hypotheses for this portion of the + transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + (``is_final=false``). The default of 0.0 is a sentinel value + indicating ``stability`` was not set. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + is_final: bool = proto.Field( + proto.BOOL, + number=2, + ) + stability: float = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag: int = proto.Field( + proto.INT32, + number=5, + ) + language_code: str = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + channel_tag: int = proto.Field( + proto.INT32, + number=2, + ) + result_end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + language_code: str = proto.Field( + proto.STRING, + number=5, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. In languages that use spaces to + separate words, the transcript might have a + leading space if it isn't the first result. You + can concatenate each result to obtain the full + transcript without using a separator. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (MutableSequence[google.cloud.speech_v1.types.WordInfo]): + A list of word-specific information for each recognized + word. Note: When ``enable_speaker_diarization`` is true, you + will see all the words from the beginning of the audio. + """ + + transcript: str = proto.Field( + proto.STRING, + number=1, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=2, + ) + words: MutableSequence['WordInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='WordInfo', + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + + Attributes: + start_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + end_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + word (str): + The word corresponding to this set of + information. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + speaker_tag (int): + Output only. A distinct integer value is assigned for every + speaker within the audio. This field specifies which one of + those speakers was detected to have spoken this word. Value + ranges from '1' to diarization_speaker_count. speaker_tag is + set if enable_speaker_diarization = 'true' and only in the + top alternative. + """ + + start_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word: str = proto.Field( + proto.STRING, + number=3, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=4, + ) + speaker_tag: int = proto.Field( + proto.INT32, + number=5, + ) + + +class SpeechAdaptationInfo(proto.Message): + r"""Information on speech adaptation use in results + + Attributes: + adaptation_timeout (bool): + Whether there was a timeout when applying + speech adaptation. If true, adaptation had no + effect in the response transcript. + timeout_message (str): + If set, returns a message specifying which + part of the speech adaptation request timed out. + """ + + adaptation_timeout: bool = proto.Field( + proto.BOOL, + number=1, + ) + timeout_message: str = proto.Field( + proto.STRING, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech_adaptation.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech_adaptation.py new file mode 100644 index 00000000..8dbf5873 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech_adaptation.py @@ -0,0 +1,423 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.cloud.speech_v1.types import resource +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1', + manifest={ + 'CreatePhraseSetRequest', + 'UpdatePhraseSetRequest', + 'GetPhraseSetRequest', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'DeletePhraseSetRequest', + 'CreateCustomClassRequest', + 'UpdateCustomClassRequest', + 'GetCustomClassRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'DeleteCustomClassRequest', + }, +) + + +class CreatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``CreatePhraseSet`` method. + + Attributes: + parent (str): + Required. The parent resource where this phrase set will be + created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + phrase_set_id (str): + Required. The ID to use for the phrase set, + which will become the final component of the + phrase set's resource name. + + This value should restrict to letters, numbers, + and hyphens, with the first character a letter, + the last a letter or a number, and be 4-63 + characters. + phrase_set (google.cloud.speech_v1.types.PhraseSet): + Required. The phrase set to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + phrase_set_id: str = proto.Field( + proto.STRING, + number=2, + ) + phrase_set: resource.PhraseSet = proto.Field( + proto.MESSAGE, + number=3, + message=resource.PhraseSet, + ) + + +class UpdatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``UpdatePhraseSet`` method. + + Attributes: + phrase_set (google.cloud.speech_v1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the set + to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + phrase_set: resource.PhraseSet = proto.Field( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``GetPhraseSet`` method. + + Attributes: + name (str): + Required. The name of the phrase set to retrieve. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``ListPhraseSet`` method. + + Attributes: + parent (str): + Required. The parent, which owns this collection of phrase + set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + page_size (int): + The maximum number of phrase sets to return. + The service may return fewer than this value. If + unspecified, at most 50 phrase sets will be + returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListPhraseSet`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListPhraseSet`` must match the call that provided the page + token. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListPhraseSetResponse(proto.Message): + r"""Message returned to the client by the ``ListPhraseSet`` method. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v1.types.PhraseSet]): + The phrase set. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + phrase_sets: MutableSequence[resource.PhraseSet] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeletePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``DeletePhraseSet`` method. + + Attributes: + name (str): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``CreateCustomClass`` method. + + Attributes: + parent (str): + Required. The parent resource where this custom class will + be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + custom_class_id (str): + Required. The ID to use for the custom class, + which will become the final component of the + custom class' resource name. + + This value should restrict to letters, numbers, + and hyphens, with the first character a letter, + the last a letter or a number, and be 4-63 + characters. + custom_class (google.cloud.speech_v1.types.CustomClass): + Required. The custom class to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id: str = proto.Field( + proto.STRING, + number=2, + ) + custom_class: resource.CustomClass = proto.Field( + proto.MESSAGE, + number=3, + message=resource.CustomClass, + ) + + +class UpdateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``UpdateCustomClass`` method. + + Attributes: + custom_class (google.cloud.speech_v1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify the + custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + custom_class: resource.CustomClass = proto.Field( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``GetCustomClass`` method. + + Attributes: + name (str): + Required. The name of the custom class to retrieve. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListCustomClassesRequest(proto.Message): + r"""Message sent by the client for the ``ListCustomClasses`` method. + + Attributes: + parent (str): + Required. The parent, which owns this collection of custom + classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + page_size (int): + The maximum number of custom classes to + return. The service may return fewer than this + value. If unspecified, at most 50 custom classes + will be returned. The maximum value is 1000; + values above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListCustomClass`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListCustomClass`` must match the call that provided the + page token. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListCustomClassesResponse(proto.Message): + r"""Message returned to the client by the ``ListCustomClasses`` method. + + Attributes: + custom_classes (MutableSequence[google.cloud.speech_v1.types.CustomClass]): + The custom classes. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + custom_classes: MutableSequence[resource.CustomClass] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``DeleteCustomClass`` method. + + Attributes: + name (str): + Required. The name of the custom class to delete. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/resource.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/resource.py new file mode 100644 index 00000000..a86551f9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/resource.py @@ -0,0 +1,232 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1', + manifest={ + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', + }, +) + + +class CustomClass(proto.Message): + r"""A set of words or phrases that represents a common concept + likely to appear in your audio, for example a list of passenger + ship names. CustomClass items can be substituted into + placeholders that you set in PhraseSet phrases. + + Attributes: + name (str): + The resource name of the custom class. + custom_class_id (str): + If this custom class is a resource, the custom_class_id is + the resource id of the CustomClass. Case sensitive. + items (MutableSequence[google.cloud.speech_v1.types.CustomClass.ClassItem]): + A collection of class items. + """ + + class ClassItem(proto.Message): + r"""An item of the class. + + Attributes: + value (str): + The class item's value. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id: str = proto.Field( + proto.STRING, + number=2, + ) + items: MutableSequence[ClassItem] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ClassItem, + ) + + +class PhraseSet(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + name (str): + The resource name of the phrase set. + phrases (MutableSequence[google.cloud.speech_v1.types.PhraseSet.Phrase]): + A list of word and phrases. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 (exclusive) + and 20. We recommend using a binary search approach to + finding the optimal value for your use case as well as + adding phrases both with and without boost to your requests. + """ + + class Phrase(proto.Message): + r"""A phrases containing words and phrase "hints" so that the speech + recognition is more likely to recognize them. This can be used to + improve the accuracy for specific words and phrases, for example, if + specific commands are typically spoken by the user. This can also be + used to add additional words to the vocabulary of the recognizer. + See `usage + limits `__. + + List items can also include pre-built or custom classes containing + groups of words that represent common concepts that occur in natural + language. For example, rather than providing a phrase hint for every + month of the year (e.g. "i was born in january", "i was born in + febuary", ...), use the pre-built ``$MONTH`` class improves the + likelihood of correctly transcribing audio that includes months + (e.g. "i was born in $month"). To refer to pre-built classes, use + the class' symbol prepended with ``$`` e.g. ``$MONTH``. To refer to + custom classes that were defined inline in the request, set the + class's ``custom_class_id`` to a string unique to all class + resources and inline classes. Then use the class' id wrapped in + $\ ``{...}`` e.g. "${my-months}". To refer to custom classes + resources, use the class' id wrapped in ``${}`` (e.g. + ``${my-months}``). + + Speech-to-Text supports three locations: ``global``, ``us`` (US + North America), and ``eu`` (Europe). If you are calling the + ``speech.googleapis.com`` endpoint, use the ``global`` location. To + specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + Attributes: + value (str): + The phrase itself. + boost (float): + Hint Boost. Overrides the boost set at the phrase set level. + Positive value will increase the probability that a specific + phrase will be recognized over other similar sounding + phrases. The higher the boost, the higher the chance of + false positive recognition as well. Negative boost will + simply be ignored. Though ``boost`` can accept a wide range + of positive values, most use cases are best served with + values between 0 and 20. We recommend using a binary search + approach to finding the optimal value for your use case as + well as adding phrases both with and without boost to your + requests. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + boost: float = proto.Field( + proto.FLOAT, + number=2, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + phrases: MutableSequence[Phrase] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=Phrase, + ) + boost: float = proto.Field( + proto.FLOAT, + number=4, + ) + + +class SpeechAdaptation(proto.Message): + r"""Speech adaptation configuration. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v1.types.PhraseSet]): + A collection of phrase sets. To specify the hints inline, + leave the phrase set's ``name`` blank and fill in the rest + of its fields. Any phrase set can use any custom class. + phrase_set_references (MutableSequence[str]): + A collection of phrase set resource names to + use. + custom_classes (MutableSequence[google.cloud.speech_v1.types.CustomClass]): + A collection of custom classes. To specify the classes + inline, leave the class' ``name`` blank and fill in the rest + of its fields, giving it a unique ``custom_class_id``. Refer + to the inline defined class in phrase hints by its + ``custom_class_id``. + abnf_grammar (google.cloud.speech_v1.types.SpeechAdaptation.ABNFGrammar): + Augmented Backus-Naur form (ABNF) is a + standardized grammar notation comprised by a set + of derivation rules. See specifications: + https://www.w3.org/TR/speech-grammar + """ + + class ABNFGrammar(proto.Message): + r""" + + Attributes: + abnf_strings (MutableSequence[str]): + All declarations and rules of an ABNF grammar + broken up into multiple strings that will end up + concatenated. + """ + + abnf_strings: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + + phrase_sets: MutableSequence['PhraseSet'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + phrase_set_references: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + custom_classes: MutableSequence['CustomClass'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='CustomClass', + ) + abnf_grammar: ABNFGrammar = proto.Field( + proto.MESSAGE, + number=4, + message=ABNFGrammar, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 00000000..574c5aed --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 00000000..ec986f8c --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/speech_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==7.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1.json new file mode 100644 index 00000000..c793efe0 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1.json @@ -0,0 +1,2152 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.speech.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-speech", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v1_generated_adaptation_create_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_CreateCustomClass_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_create_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v1_generated_adaptation_create_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_CreateCustomClass_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_create_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v1_generated_adaptation_create_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_CreatePhraseSet_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_create_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v1_generated_adaptation_create_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_CreatePhraseSet_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_create_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v1_generated_adaptation_delete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_DeleteCustomClass_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_delete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v1_generated_adaptation_delete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_DeleteCustomClass_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_delete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v1_generated_adaptation_delete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_DeletePhraseSet_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_delete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v1_generated_adaptation_delete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_DeletePhraseSet_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_delete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v1_generated_adaptation_get_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_GetCustomClass_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_get_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v1_generated_adaptation_get_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_GetCustomClass_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_get_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v1_generated_adaptation_get_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_GetPhraseSet_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_get_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v1_generated_adaptation_get_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_GetPhraseSet_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_get_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.services.adaptation.pagers.ListCustomClassesAsyncPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v1_generated_adaptation_list_custom_classes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_ListCustomClasses_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_list_custom_classes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.services.adaptation.pagers.ListCustomClassesPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v1_generated_adaptation_list_custom_classes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_ListCustomClasses_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_list_custom_classes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.list_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.ListPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.ListPhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.services.adaptation.pagers.ListPhraseSetAsyncPager", + "shortName": "list_phrase_set" + }, + "description": "Sample for ListPhraseSet", + "file": "speech_v1_generated_adaptation_list_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_ListPhraseSet_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_list_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.list_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.ListPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.ListPhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.services.adaptation.pagers.ListPhraseSetPager", + "shortName": "list_phrase_set" + }, + "description": "Sample for ListPhraseSet", + "file": "speech_v1_generated_adaptation_list_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_ListPhraseSet_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_list_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v1_generated_adaptation_update_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_UpdateCustomClass_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_update_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.CustomClass", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v1_generated_adaptation_update_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_UpdateCustomClass_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_update_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationAsyncClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v1_generated_adaptation_update_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_UpdatePhraseSet_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_update_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1.AdaptationClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1.Adaptation.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.PhraseSet", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v1_generated_adaptation_update_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Adaptation_UpdatePhraseSet_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_adaptation_update_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1.SpeechAsyncClient.long_running_recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.LongRunningRecognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "LongRunningRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.LongRunningRecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "long_running_recognize" + }, + "description": "Sample for LongRunningRecognize", + "file": "speech_v1_generated_speech_long_running_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_LongRunningRecognize_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_long_running_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1.SpeechClient.long_running_recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.LongRunningRecognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "LongRunningRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.LongRunningRecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "long_running_recognize" + }, + "description": "Sample for LongRunningRecognize", + "file": "speech_v1_generated_speech_long_running_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_LongRunningRecognize_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_long_running_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1.SpeechAsyncClient.recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.RecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v1_generated_speech_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_Recognize_async", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1.SpeechClient.recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1.types.RecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v1_generated_speech_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_Recognize_sync", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1.SpeechAsyncClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v1_generated_speech_streaming_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_StreamingRecognize_async", + "segments": [ + { + "end": 65, + "start": 27, + "type": "FULL" + }, + { + "end": 65, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 58, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 61, + "start": 59, + "type": "REQUEST_EXECUTION" + }, + { + "end": 66, + "start": 62, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_streaming_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1.SpeechClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v1.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v1_generated_speech_streaming_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1_generated_Speech_StreamingRecognize_sync", + "segments": [ + { + "end": 65, + "start": 27, + "type": "FULL" + }, + { + "end": 65, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 58, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 61, + "start": 59, + "type": "REQUEST_EXECUTION" + }, + { + "end": 66, + "start": 62, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1_generated_speech_streaming_recognize_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_async.py new file mode 100644 index 00000000..42db1c0b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_CreateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_create_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = await client.create_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_CreateCustomClass_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_sync.py new file mode 100644 index 00000000..a2831732 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_custom_class_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_CreateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_create_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = client.create_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_CreateCustomClass_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_async.py new file mode 100644 index 00000000..21a47a01 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_CreatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_create_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = await client.create_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_CreatePhraseSet_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_sync.py new file mode 100644 index 00000000..fef5d9a7 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_create_phrase_set_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_CreatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_create_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = client.create_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_CreatePhraseSet_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_async.py new file mode 100644 index 00000000..a5469536 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_DeleteCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_delete_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + await client.delete_custom_class(request=request) + + +# [END speech_v1_generated_Adaptation_DeleteCustomClass_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_sync.py new file mode 100644 index 00000000..dc148ea0 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_custom_class_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_DeleteCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_delete_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + client.delete_custom_class(request=request) + + +# [END speech_v1_generated_Adaptation_DeleteCustomClass_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_async.py new file mode 100644 index 00000000..a582333c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_DeletePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_delete_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + await client.delete_phrase_set(request=request) + + +# [END speech_v1_generated_Adaptation_DeletePhraseSet_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_sync.py new file mode 100644 index 00000000..3f26c589 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_delete_phrase_set_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_DeletePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_delete_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + client.delete_phrase_set(request=request) + + +# [END speech_v1_generated_Adaptation_DeletePhraseSet_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_async.py new file mode 100644 index 00000000..412551c1 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_GetCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_get_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_GetCustomClass_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_sync.py new file mode 100644 index 00000000..aab45317 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_custom_class_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_GetCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_get_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_GetCustomClass_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_async.py new file mode 100644 index 00000000..32797943 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_GetPhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_get_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_GetPhraseSet_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_sync.py new file mode 100644 index 00000000..870e3e62 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_get_phrase_set_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_GetPhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_get_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_GetPhraseSet_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_async.py new file mode 100644 index 00000000..6ba88e61 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_ListCustomClasses_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_list_custom_classes(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v1_generated_Adaptation_ListCustomClasses_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_sync.py new file mode 100644 index 00000000..59284d49 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_custom_classes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_ListCustomClasses_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_list_custom_classes(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v1_generated_Adaptation_ListCustomClasses_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_async.py new file mode 100644 index 00000000..4be50036 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_ListPhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_list_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v1_generated_Adaptation_ListPhraseSet_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_sync.py new file mode 100644 index 00000000..a4b1a1db --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_list_phrase_set_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_ListPhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_list_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v1_generated_Adaptation_ListPhraseSet_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_async.py new file mode 100644 index 00000000..802c9e13 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_UpdateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_update_custom_class(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.UpdateCustomClassRequest( + ) + + # Make the request + response = await client.update_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_UpdateCustomClass_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_sync.py new file mode 100644 index 00000000..e883973f --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_custom_class_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_UpdateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_update_custom_class(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.UpdateCustomClassRequest( + ) + + # Make the request + response = client.update_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_UpdateCustomClass_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_async.py new file mode 100644 index 00000000..a2679a03 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_UpdatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_update_phrase_set(): + # Create a client + client = speech_v1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1.UpdatePhraseSetRequest( + ) + + # Make the request + response = await client.update_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_UpdatePhraseSet_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_sync.py new file mode 100644 index 00000000..35704beb --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_adaptation_update_phrase_set_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Adaptation_UpdatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_update_phrase_set(): + # Create a client + client = speech_v1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1.UpdatePhraseSetRequest( + ) + + # Make the request + response = client.update_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Adaptation_UpdatePhraseSet_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_async.py new file mode 100644 index 00000000..3861bb66 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for LongRunningRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_LongRunningRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_long_running_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v1_generated_Speech_LongRunningRecognize_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_sync.py new file mode 100644 index 00000000..f4cba8cb --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_long_running_recognize_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for LongRunningRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_LongRunningRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_long_running_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v1_generated_Speech_LongRunningRecognize_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_async.py new file mode 100644 index 00000000..d7bb40dc --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_async.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_Recognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Speech_Recognize_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_sync.py new file mode 100644 index 00000000..735d3e14 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_recognize_sync.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_Recognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v1_generated_Speech_Recognize_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_async.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_async.py new file mode 100644 index 00000000..d01ec445 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_async.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_StreamingRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +async def sample_streaming_recognize(): + # Create a client + client = speech_v1.SpeechAsyncClient() + + # Initialize request argument(s) + streaming_config = speech_v1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + +# [END speech_v1_generated_Speech_StreamingRecognize_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_sync.py b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_sync.py new file mode 100644 index 00000000..4e02784c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/speech_v1_generated_speech_streaming_recognize_sync.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1_generated_Speech_StreamingRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1 + + +def sample_streaming_recognize(): + # Create a client + client = speech_v1.SpeechClient() + + # Initialize request argument(s) + streaming_config = speech_v1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + +# [END speech_v1_generated_Speech_StreamingRecognize_sync] diff --git a/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py new file mode 100644 index 00000000..7c57a5db --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py @@ -0,0 +1,188 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_custom_class': ('parent', 'custom_class_id', 'custom_class', ), + 'create_phrase_set': ('parent', 'phrase_set_id', 'phrase_set', ), + 'delete_custom_class': ('name', ), + 'delete_phrase_set': ('name', ), + 'get_custom_class': ('name', ), + 'get_phrase_set': ('name', ), + 'list_custom_classes': ('parent', 'page_size', 'page_token', ), + 'list_phrase_set': ('parent', 'page_size', 'page_token', ), + 'long_running_recognize': ('config', 'audio', 'output_config', ), + 'recognize': ('config', 'audio', ), + 'streaming_recognize': ('streaming_config', 'audio_content', ), + 'update_custom_class': ('custom_class', 'update_mask', ), + 'update_phrase_set': ('phrase_set', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=speechCallTransformer(), +): + """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 speech client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 00000000..06fd97f9 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-speech' + + +description = "Google Cloud Speech API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/speech/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-speech" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt new file mode 100644 index 00000000..6c44adfe --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_adaptation.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_adaptation.py new file mode 100644 index 00000000..63aa156c --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_adaptation.py @@ -0,0 +1,7011 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1.services.adaptation import AdaptationAsyncClient +from google.cloud.speech_v1.services.adaptation import AdaptationClient +from google.cloud.speech_v1.services.adaptation import pagers +from google.cloud.speech_v1.services.adaptation import transports +from google.cloud.speech_v1.types import cloud_speech_adaptation +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert AdaptationClient._get_default_mtls_endpoint(None) is None + assert AdaptationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AdaptationClient, "grpc"), + (AdaptationAsyncClient, "grpc_asyncio"), + (AdaptationClient, "rest"), +]) +def test_adaptation_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.AdaptationGrpcTransport, "grpc"), + (transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.AdaptationRestTransport, "rest"), +]) +def test_adaptation_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AdaptationClient, "grpc"), + (AdaptationAsyncClient, "grpc_asyncio"), + (AdaptationClient, "rest"), +]) +def test_adaptation_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +def test_adaptation_client_get_transport_class(): + transport = AdaptationClient.get_transport_class() + available_transports = [ + transports.AdaptationGrpcTransport, + transports.AdaptationRestTransport, + ] + assert transport in available_transports + + transport = AdaptationClient.get_transport_class("grpc") + assert transport == transports.AdaptationGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (AdaptationClient, transports.AdaptationRestTransport, "rest"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +def test_adaptation_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(AdaptationClient, '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(AdaptationClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "true"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "false"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (AdaptationClient, transports.AdaptationRestTransport, "rest", "true"), + (AdaptationClient, transports.AdaptationRestTransport, "rest", "false"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_adaptation_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + AdaptationClient, AdaptationAsyncClient +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +def test_adaptation_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (AdaptationClient, transports.AdaptationRestTransport, "rest"), +]) +def test_adaptation_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", grpc_helpers), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (AdaptationClient, transports.AdaptationRestTransport, "rest", None), +]) +def test_adaptation_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_adaptation_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1.services.adaptation.transports.AdaptationGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = AdaptationClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", grpc_helpers), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_adaptation_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_create_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.create_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_create_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_create_phrase_set_async_from_dict(): + await test_create_phrase_set_async(request_type=dict) + + +def test_create_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.create_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.create_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + + +def test_create_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_get_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.get_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + +@pytest.mark.asyncio +async def test_get_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_get_phrase_set_async_from_dict(): + await test_get_phrase_set_async(request_type=dict) + + +def test_get_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.get_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.get_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListPhraseSetRequest, + dict, +]) +def test_list_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + ) + response = client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_set_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + client.list_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + +@pytest.mark.asyncio +async def test_list_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_phrase_set_async_from_dict(): + await test_list_phrase_set_async(request_type=dict) + + +def test_list_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + await client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_phrase_set( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_phrase_set_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_phrase_set( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +def test_list_phrase_set_pager(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_phrase_set(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in results) +def test_list_phrase_set_pages(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = list(client.list_phrase_set(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_phrase_set_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_phrase_set(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_phrase_set_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_phrase_set(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_update_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.update_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_update_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_update_phrase_set_async_from_dict(): + await test_update_phrase_set_async(request_type=dict) + + +def test_update_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +def test_update_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_phrase_set_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + client.delete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + +@pytest.mark.asyncio +async def test_delete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async_from_dict(): + await test_delete_phrase_set_async(request_type=dict) + + +def test_delete_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = None + client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_phrase_set_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.create_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + +@pytest.mark.asyncio +async def test_create_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_create_custom_class_async_from_dict(): + await test_create_custom_class_async(request_type=dict) + + +def test_create_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.create_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.create_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + + +def test_create_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetCustomClassRequest, + dict, +]) +def test_get_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_get_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.get_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + +@pytest.mark.asyncio +async def test_get_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_get_custom_class_async_from_dict(): + await test_get_custom_class_async(request_type=dict) + + +def test_get_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.get_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.get_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + response = client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + client.list_custom_classes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + +@pytest.mark.asyncio +async def test_list_custom_classes_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_from_dict(): + await test_list_custom_classes_async(request_type=dict) + + +def test_list_custom_classes_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_custom_classes_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_custom_classes_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_custom_classes_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_pager(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_custom_classes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in results) +def test_list_custom_classes_pages(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = list(client.list_custom_classes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_custom_classes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_custom_classes(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_update_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.update_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + +@pytest.mark.asyncio +async def test_update_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_update_custom_class_async_from_dict(): + await test_update_custom_class_async(request_type=dict) + + +def test_update_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +def test_update_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_custom_class_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + client.delete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + +@pytest.mark.asyncio +async def test_delete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_custom_class_async_from_dict(): + await test_delete_custom_class_async(request_type=dict) + + +def test_delete_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = None + client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_custom_class_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_create_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["phrase_set_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + jsonified_request["phraseSetId"] = 'phrase_set_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + assert "phraseSetId" in jsonified_request + assert jsonified_request["phraseSetId"] == 'phrase_set_id_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "phraseSetId", "phraseSet", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_create_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_create_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.CreatePhraseSetRequest.pb(cloud_speech_adaptation.CreatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.CreatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.create_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_phrase_set(request) + + +def test_create_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_create_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +def test_create_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_get_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.GetPhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_get_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_get_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.GetPhraseSetRequest.pb(cloud_speech_adaptation.GetPhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.GetPhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.get_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_phrase_set(request) + + +def test_get_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_get_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +def test_get_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListPhraseSetRequest, + dict, +]) +def test_list_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.ListPhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_list_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_list_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.ListPhraseSetRequest.pb(cloud_speech_adaptation.ListPhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech_adaptation.ListPhraseSetResponse.to_json(cloud_speech_adaptation.ListPhraseSetResponse()) + + request = cloud_speech_adaptation.ListPhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + client.list_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_phrase_set(request) + + +def test_list_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_list_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +def test_list_phrase_set_rest_pager(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech_adaptation.ListPhraseSetResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_phrase_set(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in results) + + pages = list(client.list_phrase_set(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request_init["phrase_set"] = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech_adaptation.UpdatePhraseSetRequest.meta.fields["phrase_set"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["phrase_set"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["phrase_set"][field])): + del request_init["phrase_set"][field][i][subfield] + else: + del request_init["phrase_set"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_update_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("phraseSet", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_update_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_update_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.UpdatePhraseSetRequest.pb(cloud_speech_adaptation.UpdatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.UpdatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.update_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_phrase_set(request) + + +def test_update_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_update_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_delete_phrase_set") as pre: + pre.assert_not_called() + pb_message = cloud_speech_adaptation.DeletePhraseSetRequest.pb(cloud_speech_adaptation.DeletePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = cloud_speech_adaptation.DeletePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_phrase_set(request) + + +def test_delete_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_delete_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +def test_delete_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.CreateCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["custom_class_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + jsonified_request["customClassId"] = 'custom_class_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + assert "customClassId" in jsonified_request + assert jsonified_request["customClassId"] == 'custom_class_id_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "customClassId", "customClass", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_create_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_create_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.CreateCustomClassRequest.pb(cloud_speech_adaptation.CreateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.CreateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.create_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_custom_class(request) + + +def test_create_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_create_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +def test_create_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetCustomClassRequest, + dict, +]) +def test_get_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_get_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.GetCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_get_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_get_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.GetCustomClassRequest.pb(cloud_speech_adaptation.GetCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.GetCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.get_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_custom_class(request) + + +def test_get_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_get_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +def test_get_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_custom_classes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_rest_required_fields(request_type=cloud_speech_adaptation.ListCustomClassesRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_custom_classes(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_custom_classes_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_custom_classes._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_custom_classes_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_list_custom_classes") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_list_custom_classes") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.ListCustomClassesRequest.pb(cloud_speech_adaptation.ListCustomClassesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech_adaptation.ListCustomClassesResponse.to_json(cloud_speech_adaptation.ListCustomClassesResponse()) + + request = cloud_speech_adaptation.ListCustomClassesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + client.list_custom_classes(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_custom_classes_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_custom_classes(request) + + +def test_list_custom_classes_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_custom_classes(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_list_custom_classes_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_rest_pager(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech_adaptation.ListCustomClassesResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_custom_classes(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in results) + + pages = list(client.list_custom_classes(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request_init["custom_class"] = {'name': 'projects/sample1/locations/sample2/customClasses/sample3', 'custom_class_id': 'custom_class_id_value', 'items': [{'value': 'value_value'}]} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech_adaptation.UpdateCustomClassRequest.meta.fields["custom_class"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["custom_class"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["custom_class"][field])): + del request_init["custom_class"][field][i][subfield] + else: + del request_init["custom_class"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_update_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("customClass", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_update_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_update_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.UpdateCustomClassRequest.pb(cloud_speech_adaptation.UpdateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.UpdateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.update_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_custom_class(request) + + +def test_update_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{custom_class.name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_update_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_custom_class(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_delete_custom_class") as pre: + pre.assert_not_called() + pb_message = cloud_speech_adaptation.DeleteCustomClassRequest.pb(cloud_speech_adaptation.DeleteCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = cloud_speech_adaptation.DeleteCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_custom_class(request) + + +def test_delete_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_delete_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +def test_delete_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AdaptationClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AdaptationClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AdaptationClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AdaptationGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + transports.AdaptationRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = AdaptationClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AdaptationGrpcTransport, + ) + +def test_adaptation_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_adaptation_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1.services.adaptation.transports.AdaptationTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_phrase_set', + 'get_phrase_set', + 'list_phrase_set', + 'update_phrase_set', + 'delete_phrase_set', + 'create_custom_class', + 'get_custom_class', + 'list_custom_classes', + 'update_custom_class', + 'delete_custom_class', + 'get_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_adaptation_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.speech_v1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_adaptation_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.speech_v1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport() + adc.assert_called_once() + + +def test_adaptation_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) + AdaptationClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + ], +) +def test_adaptation_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.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + transports.AdaptationRestTransport, + ], +) +def test_adaptation_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AdaptationGrpcTransport, grpc_helpers), + (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_adaptation_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( + "speech.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="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_adaptation_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.AdaptationRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_adaptation_host_no_port(transport_name): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_adaptation_host_with_port(transport_name): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_adaptation_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = AdaptationClient( + credentials=creds1, + transport=transport_name, + ) + client2 = AdaptationClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_phrase_set._session + session2 = client2.transport.create_phrase_set._session + assert session1 != session2 + session1 = client1.transport.get_phrase_set._session + session2 = client2.transport.get_phrase_set._session + assert session1 != session2 + session1 = client1.transport.list_phrase_set._session + session2 = client2.transport.list_phrase_set._session + assert session1 != session2 + session1 = client1.transport.update_phrase_set._session + session2 = client2.transport.update_phrase_set._session + assert session1 != session2 + session1 = client1.transport.delete_phrase_set._session + session2 = client2.transport.delete_phrase_set._session + assert session1 != session2 + session1 = client1.transport.create_custom_class._session + session2 = client2.transport.create_custom_class._session + assert session1 != session2 + session1 = client1.transport.get_custom_class._session + session2 = client2.transport.get_custom_class._session + assert session1 != session2 + session1 = client1.transport.list_custom_classes._session + session2 = client2.transport.list_custom_classes._session + assert session1 != session2 + session1 = client1.transport.update_custom_class._session + session2 = client2.transport.update_custom_class._session + assert session1 != session2 + session1 = client1.transport.delete_custom_class._session + session2 = client2.transport.delete_custom_class._session + assert session1 != session2 +def test_adaptation_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcTransport( + 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_adaptation_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcAsyncIOTransport( + 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = AdaptationClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = AdaptationClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = AdaptationClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = AdaptationClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = AdaptationClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = AdaptationClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = AdaptationClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = AdaptationClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = AdaptationClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = AdaptationClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = AdaptationClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = AdaptationClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.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 = AdaptationClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = AdaptationClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + transport_class = AdaptationClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_get_operation(transport: str = "grpc"): + client = AdaptationClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = AdaptationAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = AdaptationClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = AdaptationAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = AdaptationClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = AdaptationAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = AdaptationClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = AdaptationAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (AdaptationClient, transports.AdaptationGrpcTransport), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py new file mode 100644 index 00000000..90986b62 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py @@ -0,0 +1,2576 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1.services.speech import SpeechAsyncClient +from google.cloud.speech_v1.services.speech import SpeechClient +from google.cloud.speech_v1.services.speech import transports +from google.cloud.speech_v1.types import cloud_speech +from google.cloud.speech_v1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.SpeechGrpcTransport, "grpc"), + (transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + transports.SpeechRestTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_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(SpeechClient, '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(SpeechClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (SpeechClient, transports.SpeechRestTransport, "rest", "true"), + (SpeechClient, transports.SpeechRestTransport, "rest", "false"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, SpeechAsyncClient +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (SpeechClient, transports.SpeechRestTransport, "rest", None), +]) +def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_speech_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_speech_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse( + request_id=1077, + ) + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +def test_recognize_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 = SpeechClient( + 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.recognize), + '__call__') as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + +@pytest.mark.asyncio +async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): + client = SpeechAsyncClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( + request_id=1077, + )) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + + +def test_recognize_flattened_error(): + client = SpeechClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.LongRunningRecognizeRequest, + dict, +]) +def test_long_running_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_long_running_recognize_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 = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + client.long_running_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + +@pytest.mark.asyncio +async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechAsyncClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_long_running_recognize_async_from_dict(): + await test_long_running_recognize_async(request_type=dict) + + +def test_long_running_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + + +def test_long_running_recognize_flattened_error(): + client = SpeechClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.StreamingRecognizeRequest, + dict, +]) +def test_streaming_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechAsyncClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse( + request_id=1077, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.recognize(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +def test_recognize_rest_required_fields(request_type=cloud_speech.RecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("config", "audio", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.RecognizeRequest.pb(cloud_speech.RecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.RecognizeResponse.to_json(cloud_speech.RecognizeResponse()) + + request = cloud_speech.RecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.RecognizeResponse() + + client.recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.RecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.recognize(request) + + +def test_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/speech:recognize" % client.transport._host, args[1]) + + +def test_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.LongRunningRecognizeRequest, + dict, +]) +def test_long_running_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.long_running_recognize(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_long_running_recognize_rest_required_fields(request_type=cloud_speech.LongRunningRecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).long_running_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).long_running_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.long_running_recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_long_running_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.long_running_recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("config", "audio", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_long_running_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_long_running_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_long_running_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.LongRunningRecognizeRequest.pb(cloud_speech.LongRunningRecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.LongRunningRecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.long_running_recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_long_running_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.long_running_recognize(request) + + +def test_long_running_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.long_running_recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/speech:longrunningrecognize" % client.transport._host, args[1]) + + +def test_long_running_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_long_running_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_streaming_recognize_rest_no_http_options(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = cloud_speech.StreamingRecognizeRequest() + requests = [request] + with pytest.raises(RuntimeError): + client.streaming_recognize(requests) + + +def test_streaming_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + # Since a `google.api.http` annotation is required for using a rest transport + # method, this should error. + with pytest.raises(NotImplementedError) as not_implemented_error: + client.streaming_recognize({}) + assert ( + "Method StreamingRecognize is not available over REST transport" + in str(not_implemented_error.value) + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = SpeechClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'recognize', + 'long_running_recognize', + 'streaming_recognize', + 'get_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +def test_speech_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) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_speech_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.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, + ], +) +def test_speech_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_speech_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( + "speech.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="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_speech_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.SpeechRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_speech_rest_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_no_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_with_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_speech_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = SpeechClient( + credentials=creds1, + transport=transport_name, + ) + client2 = SpeechClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.recognize._session + session2 = client2.transport.recognize._session + assert session1 != session2 + session1 = client1.transport.long_running_recognize._session + session2 = client2.transport.long_running_recognize._session + assert session1 != session2 + session1 = client1.transport.streaming_recognize._session + session2 = client2.transport.streaming_recognize._session + assert session1 != session2 +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + 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_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_speech_grpc_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = SpeechClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = SpeechClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = SpeechClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = SpeechClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.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 = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_get_operation(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (SpeechClient, transports.SpeechGrpcTransport), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v1p1beta1/.coveragerc b/owl-bot-staging/v1p1beta1/.coveragerc new file mode 100644 index 00000000..2a1c2d22 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/speech/__init__.py + google/cloud/speech/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1p1beta1/.flake8 b/owl-bot-staging/v1p1beta1/.flake8 new file mode 100644 index 00000000..29227d4c --- /dev/null +++ b/owl-bot-staging/v1p1beta1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1p1beta1/MANIFEST.in b/owl-bot-staging/v1p1beta1/MANIFEST.in new file mode 100644 index 00000000..1f464b43 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/speech *.py +recursive-include google/cloud/speech_v1p1beta1 *.py diff --git a/owl-bot-staging/v1p1beta1/README.rst b/owl-bot-staging/v1p1beta1/README.rst new file mode 100644 index 00000000..36384b14 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Speech 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 Speech 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/v1p1beta1/docs/_static/custom.css b/owl-bot-staging/v1p1beta1/docs/_static/custom.css new file mode 100644 index 00000000..06423be0 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/_static/custom.css @@ -0,0 +1,3 @@ +dl.field-list > dt { + min-width: 100px +} diff --git a/owl-bot-staging/v1p1beta1/docs/conf.py b/owl-bot-staging/v1p1beta1/docs/conf.py new file mode 100644 index 00000000..3f5925bc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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-speech documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-speech" +copyright = u"2023, 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 = 'en' + +# 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-speech-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-speech.tex", + u"google-cloud-speech Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-speech", + u"Google Cloud Speech Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-speech", + u"google-cloud-speech Documentation", + author, + "google-cloud-speech", + "GAPIC library for Google Cloud Speech 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/v1p1beta1/docs/index.rst b/owl-bot-staging/v1p1beta1/docs/index.rst new file mode 100644 index 00000000..68cf3cee --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + speech_v1p1beta1/services + speech_v1p1beta1/types diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst new file mode 100644 index 00000000..7644e3ca --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst @@ -0,0 +1,10 @@ +Adaptation +---------------------------- + +.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation + :members: + :inherited-members: + +.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services_.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services_.rst new file mode 100644 index 00000000..d4982074 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services_.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Speech v1p1beta1 API +============================================== +.. toctree:: + :maxdepth: 2 + + adaptation + speech diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst new file mode 100644 index 00000000..bd3e379a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst @@ -0,0 +1,6 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v1p1beta1.services.speech + :members: + :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types_.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types_.rst new file mode 100644 index 00000000..96ebe607 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Speech v1p1beta1 API +=========================================== + +.. automodule:: google.cloud.speech_v1p1beta1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py new file mode 100644 index 00000000..9e83de8e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py @@ -0,0 +1,101 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.speech_v1p1beta1.services.adaptation.client import AdaptationClient +from google.cloud.speech_v1p1beta1.services.adaptation.async_client import AdaptationAsyncClient +from google.cloud.speech_v1p1beta1.services.speech.client import SpeechClient +from google.cloud.speech_v1p1beta1.services.speech.async_client import SpeechAsyncClient + +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeMetadata +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionAudio +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionMetadata +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeakerDiarizationConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechAdaptationInfo +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechContext +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionAlternative +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionResult +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionResult +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import TranscriptOutputConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import WordInfo +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreateCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreatePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeleteCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeletePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetPhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdateCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdatePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.resource import CustomClass +from google.cloud.speech_v1p1beta1.types.resource import PhraseSet +from google.cloud.speech_v1p1beta1.types.resource import SpeechAdaptation +from google.cloud.speech_v1p1beta1.types.resource import TranscriptNormalization + +__all__ = ('AdaptationClient', + 'AdaptationAsyncClient', + 'SpeechClient', + 'SpeechAsyncClient', + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptationInfo', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', + 'TranscriptNormalization', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/gapic_version.py b/owl-bot-staging/v1p1beta1/google/cloud/speech/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py new file mode 100644 index 00000000..53661f9d --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py @@ -0,0 +1,102 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech_v1p1beta1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.adaptation import AdaptationClient +from .services.adaptation import AdaptationAsyncClient +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import LongRunningRecognizeMetadata +from .types.cloud_speech import LongRunningRecognizeRequest +from .types.cloud_speech import LongRunningRecognizeResponse +from .types.cloud_speech import RecognitionAudio +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionMetadata +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechAdaptationInfo +from .types.cloud_speech import SpeechContext +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import TranscriptOutputConfig +from .types.cloud_speech import WordInfo +from .types.cloud_speech_adaptation import CreateCustomClassRequest +from .types.cloud_speech_adaptation import CreatePhraseSetRequest +from .types.cloud_speech_adaptation import DeleteCustomClassRequest +from .types.cloud_speech_adaptation import DeletePhraseSetRequest +from .types.cloud_speech_adaptation import GetCustomClassRequest +from .types.cloud_speech_adaptation import GetPhraseSetRequest +from .types.cloud_speech_adaptation import ListCustomClassesRequest +from .types.cloud_speech_adaptation import ListCustomClassesResponse +from .types.cloud_speech_adaptation import ListPhraseSetRequest +from .types.cloud_speech_adaptation import ListPhraseSetResponse +from .types.cloud_speech_adaptation import UpdateCustomClassRequest +from .types.cloud_speech_adaptation import UpdatePhraseSetRequest +from .types.resource import CustomClass +from .types.resource import PhraseSet +from .types.resource import SpeechAdaptation +from .types.resource import TranscriptNormalization + +__all__ = ( + 'AdaptationAsyncClient', + 'SpeechAsyncClient', +'AdaptationClient', +'CreateCustomClassRequest', +'CreatePhraseSetRequest', +'CustomClass', +'DeleteCustomClassRequest', +'DeletePhraseSetRequest', +'GetCustomClassRequest', +'GetPhraseSetRequest', +'ListCustomClassesRequest', +'ListCustomClassesResponse', +'ListPhraseSetRequest', +'ListPhraseSetResponse', +'LongRunningRecognizeMetadata', +'LongRunningRecognizeRequest', +'LongRunningRecognizeResponse', +'PhraseSet', +'RecognitionAudio', +'RecognitionConfig', +'RecognitionMetadata', +'RecognizeRequest', +'RecognizeResponse', +'SpeakerDiarizationConfig', +'SpeechAdaptation', +'SpeechAdaptationInfo', +'SpeechClient', +'SpeechContext', +'SpeechRecognitionAlternative', +'SpeechRecognitionResult', +'StreamingRecognitionConfig', +'StreamingRecognitionResult', +'StreamingRecognizeRequest', +'StreamingRecognizeResponse', +'TranscriptNormalization', +'TranscriptOutputConfig', +'UpdateCustomClassRequest', +'UpdatePhraseSetRequest', +'WordInfo', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json new file mode 100644 index 00000000..a1a3a774 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json @@ -0,0 +1,242 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v1p1beta1", + "protoPackage": "google.cloud.speech.v1p1beta1", + "schema": "1.0", + "services": { + "Adaptation": { + "clients": { + "grpc": { + "libraryClient": "AdaptationClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AdaptationAsyncClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + }, + "rest": { + "libraryClient": "AdaptationClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + } + } + }, + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "rest": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_version.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py new file mode 100644 index 00000000..89a37dc9 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py new file mode 100644 index 00000000..e54a0bf0 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 AdaptationClient +from .async_client import AdaptationAsyncClient + +__all__ = ( + 'AdaptationClient', + 'AdaptationAsyncClient', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py new file mode 100644 index 00000000..2e4054d8 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py @@ -0,0 +1,1491 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .client import AdaptationClient + + +class AdaptationAsyncClient: + """Service that implements Google Cloud Speech Adaptation API.""" + + _client: AdaptationClient + + DEFAULT_ENDPOINT = AdaptationClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AdaptationClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(AdaptationClient.custom_class_path) + parse_custom_class_path = staticmethod(AdaptationClient.parse_custom_class_path) + phrase_set_path = staticmethod(AdaptationClient.phrase_set_path) + parse_phrase_set_path = staticmethod(AdaptationClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(AdaptationClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(AdaptationClient.parse_common_billing_account_path) + common_folder_path = staticmethod(AdaptationClient.common_folder_path) + parse_common_folder_path = staticmethod(AdaptationClient.parse_common_folder_path) + common_organization_path = staticmethod(AdaptationClient.common_organization_path) + parse_common_organization_path = staticmethod(AdaptationClient.parse_common_organization_path) + common_project_path = staticmethod(AdaptationClient.common_project_path) + parse_common_project_path = staticmethod(AdaptationClient.parse_common_project_path) + common_location_path = staticmethod(AdaptationClient.common_location_path) + parse_common_location_path = staticmethod(AdaptationClient.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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_info.__func__(AdaptationAsyncClient, 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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_file.__func__(AdaptationAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return AdaptationClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(AdaptationClient).get_transport_class, type(AdaptationClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, AdaptationTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, ~.AdaptationTransport]): 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 = AdaptationClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[resource.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_create_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = await client.create_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + parent (:class:`str`): + Required. The parent resource where this phrase set will + be created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (:class:`str`): + Required. The ID to use for the + phrase set, which will become the final + component of the phrase set's resource + name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.CreatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_phrase_set, + 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 + + async def get_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_get_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + name (:class:`str`): + Required. The name of the phrase set to retrieve. + Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.ListPhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetAsyncPager: + r"""List phrase sets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_list_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + parent (:class:`str`): + Required. The parent, which owns this collection of + phrase set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetAsyncPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.ListPhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListPhraseSetAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[resource.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_update_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdatePhraseSetRequest( + ) + + # Make the request + response = await client.update_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``phrase_set`` 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set, + 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(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_delete_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + await client.delete_phrase_set(request=request) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest, dict]]): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + name (:class:`str`): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.DeletePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_phrase_set, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def create_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[resource.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_create_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = await client.create_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + parent (:class:`str`): + Required. The parent resource where this custom class + will be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (:class:`str`): + Required. The ID to use for the + custom class, which will become the + final component of the custom class' + resource name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.CreateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_custom_class, + 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 + + async def get_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_get_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.GetCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + name (:class:`str`): + Required. The name of the custom class to retrieve. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_custom_classes(self, + request: Optional[Union[cloud_speech_adaptation.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesAsyncPager: + r"""List custom classes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_list_custom_classes(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest, dict]]): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + parent (:class:`str`): + Required. The parent, which owns this collection of + custom classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesAsyncPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.ListCustomClassesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_custom_classes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListCustomClassesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[resource.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_update_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdateCustomClassRequest( + ) + + # Make the request + response = await client.update_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``custom_class`` 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 = cloud_speech_adaptation.UpdateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class, + 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(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_delete_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + await client.delete_custom_class(request=request) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest, dict]]): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + name (:class:`str`): + Required. The name of the custom class to delete. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech_adaptation.DeleteCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_custom_class, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + 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 __aenter__(self) -> "AdaptationAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AdaptationAsyncClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py new file mode 100644 index 00000000..bcff658f --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py @@ -0,0 +1,1706 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import AdaptationGrpcTransport +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .transports.rest import AdaptationRestTransport + + +class AdaptationClientMeta(type): + """Metaclass for the Adaptation 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[AdaptationTransport]] + _transport_registry["grpc"] = AdaptationGrpcTransport + _transport_registry["grpc_asyncio"] = AdaptationGrpcAsyncIOTransport + _transport_registry["rest"] = AdaptationRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[AdaptationTransport]: + """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 AdaptationClient(metaclass=AdaptationClientMeta): + """Service that implements Google Cloud Speech Adaptation API.""" + + @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 = "speech.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: + AdaptationClient: 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: + AdaptationClient: 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) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, AdaptationTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, AdaptationTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, AdaptationTransport): + # transport is a AdaptationTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def create_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[resource.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_create_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = client.create_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + parent (str): + Required. The parent resource where this phrase set will + be created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (str): + Required. The ID to use for the + phrase set, which will become the final + component of the phrase set's resource + name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.CreatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreatePhraseSetRequest): + request = cloud_speech_adaptation.CreatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] + + # 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 get_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_get_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest, dict]): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + name (str): + Required. The name of the phrase set to retrieve. + Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.GetPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetPhraseSetRequest): + request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.ListPhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetPager: + r"""List phrase sets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_list_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest, dict]): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + parent (str): + Required. The parent, which owns this collection of + phrase set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.ListPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListPhraseSetRequest): + request = cloud_speech_adaptation.ListPhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListPhraseSetPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[resource.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_update_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdatePhraseSetRequest( + ) + + # Make the request + response = client.update_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``phrase_set`` 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 cloud_speech_adaptation.UpdatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdatePhraseSetRequest): + request = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_phrase_set(self, + request: Optional[Union[cloud_speech_adaptation.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_delete_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + client.delete_phrase_set(request=request) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest, dict]): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + name (str): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.DeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeletePhraseSetRequest): + request = cloud_speech_adaptation.DeletePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def create_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[resource.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_create_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = client.create_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest, dict]): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + parent (str): + Required. The parent resource where this custom class + will be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (str): + Required. The ID to use for the + custom class, which will become the + final component of the custom class' + resource name. + + This value should restrict to letters, + numbers, and hyphens, with the first + character a letter, the last a letter or + a number, and be 4-63 characters. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.CreateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreateCustomClassRequest): + request = cloud_speech_adaptation.CreateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_custom_class] + + # 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 get_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_get_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.GetCustomClassRequest, dict]): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + name (str): + Required. The name of the custom class to retrieve. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.GetCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetCustomClassRequest): + request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_custom_classes(self, + request: Optional[Union[cloud_speech_adaptation.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesPager: + r"""List custom classes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_list_custom_classes(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest, dict]): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + parent (str): + Required. The parent, which owns this collection of + custom classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.ListCustomClassesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListCustomClassesRequest): + request = cloud_speech_adaptation.ListCustomClassesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_custom_classes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListCustomClassesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[resource.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_update_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdateCustomClassRequest( + ) + + # Make the request + response = client.update_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest, dict]): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``custom_class`` 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 cloud_speech_adaptation.UpdateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdateCustomClassRequest): + request = cloud_speech_adaptation.UpdateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_custom_class(self, + request: Optional[Union[cloud_speech_adaptation.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_delete_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + client.delete_custom_class(request=request) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest, dict]): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + name (str): + Required. The name of the custom class to delete. + Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, + ``us`` (US North America), and ``eu`` (Europe). If you + are calling the ``speech.googleapis.com`` endpoint, use + the ``global`` location. To specify a region, use a + `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech_adaptation.DeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeleteCustomClassRequest): + request = cloud_speech_adaptation.DeleteCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def __enter__(self) -> "AdaptationClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AdaptationClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py new file mode 100644 index 00000000..b2d1bde7 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py @@ -0,0 +1,261 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource + + +class ListPhraseSetPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and + provides an ``__iter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech_adaptation.ListPhraseSetResponse], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech_adaptation.ListPhraseSetResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[resource.PhraseSet]: + for page in self.pages: + yield from page.phrase_sets + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListPhraseSetAsyncPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech_adaptation.ListPhraseSetResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[resource.PhraseSet]: + async def async_generator(): + async for page in self.pages: + for response in page.phrase_sets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech_adaptation.ListCustomClassesResponse], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech_adaptation.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[resource.CustomClass]: + for page in self.pages: + yield from page.custom_classes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesAsyncPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech_adaptation.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[resource.CustomClass]: + async def async_generator(): + async for page in self.pages: + for response in page.custom_classes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py new file mode 100644 index 00000000..40a3b5b1 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 AdaptationTransport +from .grpc import AdaptationGrpcTransport +from .grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .rest import AdaptationRestTransport +from .rest import AdaptationRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[AdaptationTransport]] +_transport_registry['grpc'] = AdaptationGrpcTransport +_transport_registry['grpc_asyncio'] = AdaptationGrpcAsyncIOTransport +_transport_registry['rest'] = AdaptationRestTransport + +__all__ = ( + 'AdaptationTransport', + 'AdaptationGrpcTransport', + 'AdaptationGrpcAsyncIOTransport', + 'AdaptationRestTransport', + 'AdaptationRestInterceptor', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py new file mode 100644 index 00000000..25fc0edc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py @@ -0,0 +1,295 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class AdaptationTransport(abc.ABC): + """Abstract transport class for Adaptation.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_phrase_set: gapic_v1.method.wrap_method( + self.create_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.get_phrase_set: gapic_v1.method.wrap_method( + self.get_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.list_phrase_set: gapic_v1.method.wrap_method( + self.list_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.update_phrase_set: gapic_v1.method.wrap_method( + self.update_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.delete_phrase_set: gapic_v1.method.wrap_method( + self.delete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.create_custom_class: gapic_v1.method.wrap_method( + self.create_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.get_custom_class: gapic_v1.method.wrap_method( + self.get_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.list_custom_classes: gapic_v1.method.wrap_method( + self.list_custom_classes, + default_timeout=None, + client_info=client_info, + ), + self.update_custom_class: gapic_v1.method.wrap_method( + self.update_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.delete_custom_class: gapic_v1.method.wrap_method( + self.delete_custom_class, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Union[ + cloud_speech_adaptation.ListPhraseSetResponse, + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse] + ]]: + raise NotImplementedError() + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Union[ + cloud_speech_adaptation.ListCustomClassesResponse, + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse] + ]]: + raise NotImplementedError() + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'AdaptationTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py new file mode 100644 index 00000000..eb65794c --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py @@ -0,0 +1,540 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO + + +class AdaptationGrpcTransport(AdaptationTransport): + """gRPC backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + cloud_speech_adaptation.ListPhraseSetResponse]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + ~.ListPhraseSetResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + cloud_speech_adaptation.ListCustomClassesResponse]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + ~.ListCustomClassesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + def close(self): + self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'AdaptationGrpcTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py new file mode 100644 index 00000000..aa7ed9a4 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py @@ -0,0 +1,539 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .grpc import AdaptationGrpcTransport + + +class AdaptationGrpcAsyncIOTransport(AdaptationTransport): + """gRPC AsyncIO backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + Awaitable[~.ListPhraseSetResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + Awaitable[~.ListCustomClassesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + def close(self): + return self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + +__all__ = ( + 'AdaptationGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/rest.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/rest.py new file mode 100644 index 00000000..87144d3a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/rest.py @@ -0,0 +1,1484 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import empty_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore + +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class AdaptationRestInterceptor: + """Interceptor for Adaptation. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the AdaptationRestTransport. + + .. code-block:: python + class MyCustomAdaptationInterceptor(AdaptationRestInterceptor): + def pre_create_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_custom_classes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_custom_classes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + transport = AdaptationRestTransport(interceptor=MyCustomAdaptationInterceptor()) + client = AdaptationClient(transport=transport) + + + """ + def pre_create_custom_class(self, request: cloud_speech_adaptation.CreateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.CreateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_create_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_create_phrase_set(self, request: cloud_speech_adaptation.CreatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.CreatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_create_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_delete_custom_class(self, request: cloud_speech_adaptation.DeleteCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.DeleteCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def pre_delete_phrase_set(self, request: cloud_speech_adaptation.DeletePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.DeletePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def pre_get_custom_class(self, request: cloud_speech_adaptation.GetCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.GetCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_get_phrase_set(self, request: cloud_speech_adaptation.GetPhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.GetPhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_custom_classes(self, request: cloud_speech_adaptation.ListCustomClassesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.ListCustomClassesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_custom_classes(self, response: cloud_speech_adaptation.ListCustomClassesResponse) -> cloud_speech_adaptation.ListCustomClassesResponse: + """Post-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_phrase_set(self, request: cloud_speech_adaptation.ListPhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.ListPhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_phrase_set(self, response: cloud_speech_adaptation.ListPhraseSetResponse) -> cloud_speech_adaptation.ListPhraseSetResponse: + """Post-rpc interceptor for list_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_update_custom_class(self, request: cloud_speech_adaptation.UpdateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.UpdateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_update_custom_class(self, response: resource.CustomClass) -> resource.CustomClass: + """Post-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_update_phrase_set(self, request: cloud_speech_adaptation.UpdatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech_adaptation.UpdatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_update_phrase_set(self, response: resource.PhraseSet) -> resource.PhraseSet: + """Post-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Adaptation server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Adaptation server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class AdaptationRestStub: + _session: AuthorizedSession + _host: str + _interceptor: AdaptationRestInterceptor + + +class AdaptationRestTransport(AdaptationTransport): + """REST backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[AdaptationRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or AdaptationRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("CreateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.CreateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the create custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.CreateCustomClassRequest): + The request object. Message sent by the client for the ``CreateCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1p1beta1/{parent=projects/*/locations/*}/customClasses', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_create_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.CreateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_custom_class(resp) + return resp + + class _CreatePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("CreatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.CreatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the create phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.CreatePhraseSetRequest): + The request object. Message sent by the client for the ``CreatePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1p1beta1/{parent=projects/*/locations/*}/phraseSets', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_create_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.CreatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_phrase_set(resp) + return resp + + class _DeleteCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("DeleteCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.DeleteCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.DeleteCustomClassRequest): + The request object. Message sent by the client for the ``DeleteCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1p1beta1/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.DeleteCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeletePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("DeletePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.DeletePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.DeletePhraseSetRequest): + The request object. Message sent by the client for the ``DeletePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.DeletePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("GetCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.GetCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the get custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.GetCustomClassRequest): + The request object. Message sent by the client for the ``GetCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_get_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.GetCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_custom_class(resp) + return resp + + class _GetPhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("GetPhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.GetPhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the get phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.GetPhraseSetRequest): + The request object. Message sent by the client for the ``GetPhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_get_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.GetPhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_phrase_set(resp) + return resp + + class _ListCustomClasses(AdaptationRestStub): + def __hash__(self): + return hash("ListCustomClasses") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.ListCustomClassesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech_adaptation.ListCustomClassesResponse: + r"""Call the list custom classes method over HTTP. + + Args: + request (~.cloud_speech_adaptation.ListCustomClassesRequest): + The request object. Message sent by the client for the ``ListCustomClasses`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech_adaptation.ListCustomClassesResponse: + Message returned to the client by the + ``ListCustomClasses`` method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/{parent=projects/*/locations/*}/customClasses', + }, + ] + request, metadata = self._interceptor.pre_list_custom_classes(request, metadata) + pb_request = cloud_speech_adaptation.ListCustomClassesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech_adaptation.ListCustomClassesResponse() + pb_resp = cloud_speech_adaptation.ListCustomClassesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_custom_classes(resp) + return resp + + class _ListPhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("ListPhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.ListPhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech_adaptation.ListPhraseSetResponse: + r"""Call the list phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.ListPhraseSetRequest): + The request object. Message sent by the client for the ``ListPhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech_adaptation.ListPhraseSetResponse: + Message returned to the client by the ``ListPhraseSet`` + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/{parent=projects/*/locations/*}/phraseSets', + }, + ] + request, metadata = self._interceptor.pre_list_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.ListPhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech_adaptation.ListPhraseSetResponse() + pb_resp = cloud_speech_adaptation.ListPhraseSetResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_phrase_set(resp) + return resp + + class _UpdateCustomClass(AdaptationRestStub): + def __hash__(self): + return hash("UpdateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.UpdateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.CustomClass: + r"""Call the update custom class method over HTTP. + + Args: + request (~.cloud_speech_adaptation.UpdateCustomClassRequest): + The request object. Message sent by the client for the ``UpdateCustomClass`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1p1beta1/{custom_class.name=projects/*/locations/*/customClasses/*}', + 'body': 'custom_class', + }, + ] + request, metadata = self._interceptor.pre_update_custom_class(request, metadata) + pb_request = cloud_speech_adaptation.UpdateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.CustomClass() + pb_resp = resource.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_custom_class(resp) + return resp + + class _UpdatePhraseSet(AdaptationRestStub): + def __hash__(self): + return hash("UpdatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech_adaptation.UpdatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> resource.PhraseSet: + r"""Call the update phrase set method over HTTP. + + Args: + request (~.cloud_speech_adaptation.UpdatePhraseSetRequest): + The request object. Message sent by the client for the ``UpdatePhraseSet`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.resource.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1p1beta1/{phrase_set.name=projects/*/locations/*/phraseSets/*}', + 'body': 'phrase_set', + }, + ] + request, metadata = self._interceptor.pre_update_phrase_set(request, metadata) + pb_request = cloud_speech_adaptation.UpdatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = resource.PhraseSet() + pb_resp = resource.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_phrase_set(resp) + return resp + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeletePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetPhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + cloud_speech_adaptation.ListCustomClassesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListCustomClasses(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + cloud_speech_adaptation.ListPhraseSetResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListPhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + resource.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + resource.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(AdaptationRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/operations/{name=**}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(AdaptationRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'AdaptationRestTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py new file mode 100644 index 00000000..0b9e4f6e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + 'SpeechClient', + 'SpeechAsyncClient', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py new file mode 100644 index 00000000..12baaaae --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py @@ -0,0 +1,717 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Service that implements Google Cloud Speech API.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(SpeechClient.custom_class_path) + parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) + phrase_set_path = staticmethod(SpeechClient.phrase_set_path) + parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return SpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.RecognizeRequest, dict]]): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def long_running_recognize(self, + request: Optional[Union[cloud_speech.LongRunningRecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_long_running_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest, dict]]): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.LongRunningRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.long_running_recognize, + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[AsyncIterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + async def sample_streaming_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + streaming_config = speech_v1p1beta1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1p1beta1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1p1beta1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + + Args: + requests (AsyncIterator[`google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest`]): + The request object AsyncIterator. The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The + first message must contain a ``streaming_config`` + message and must not contain ``audio_content``. All + subsequent messages must contain ``audio_content`` and + must not contain a ``streaming_config`` message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + AsyncIterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + 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 __aenter__(self) -> "SpeechAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechAsyncClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py new file mode 100644 index 00000000..26ca0f72 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py @@ -0,0 +1,914 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union, cast + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .transports.rest import SpeechRestTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech 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[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + _transport_registry["rest"] = SpeechRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[SpeechTransport]: + """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 SpeechClient(metaclass=SpeechClientMeta): + """Service that implements Google Cloud Speech API.""" + + @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 = "speech.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: + SpeechClient: 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: + SpeechClient: 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) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, SpeechTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, SpeechTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.RecognizeRequest, dict]): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def long_running_recognize(self, + request: Optional[Union[cloud_speech.LongRunningRecognizeRequest, dict]] = None, + *, + config: Optional[cloud_speech.RecognitionConfig] = None, + audio: Optional[cloud_speech.RecognitionAudio] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_long_running_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest, dict]): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.LongRunningRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): + request = cloud_speech.LongRunningRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[Iterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v1p1beta1 + + def sample_streaming_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + streaming_config = speech_v1p1beta1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1p1beta1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1p1beta1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + + Args: + requests (Iterator[google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest]): + The request object iterator. The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The + first message must contain a ``streaming_config`` + message and must not contain ``audio_content``. All + subsequent messages must contain ``audio_content`` and + must not contain a ``streaming_config`` message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + Iterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "SpeechClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py new file mode 100644 index 00000000..4bac8f03 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport +from .rest import SpeechRestTransport +from .rest import SpeechRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry['grpc'] = SpeechGrpcTransport +_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport +_transport_registry['rest'] = SpeechRestTransport + +__all__ = ( + 'SpeechTransport', + 'SpeechGrpcTransport', + 'SpeechGrpcAsyncIOTransport', + 'SpeechRestTransport', + 'SpeechRestInterceptor', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py new file mode 100644 index 00000000..bdc66a3b --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py @@ -0,0 +1,215 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.speech_v1p1beta1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + self.long_running_recognize: gapic_v1.method.wrap_method( + self.long_running_recognize, + default_timeout=5000.0, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, + Awaitable[cloud_speech.RecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'SpeechTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py new file mode 100644 index 00000000..fdbfc82a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py @@ -0,0 +1,379 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Service that implements Google Cloud Speech API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + def close(self): + self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'SpeechGrpcTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py new file mode 100644 index 00000000..238f670e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,378 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Service that implements Google Cloud Speech API. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Awaitable[cloud_speech.RecognizeResponse]]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse]]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + def close(self): + return self.grpc_channel.close() + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + +__all__ = ( + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/rest.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/rest.py new file mode 100644 index 00000000..ac5e3d7c --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/rest.py @@ -0,0 +1,655 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +from .base import SpeechTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class SpeechRestInterceptor: + """Interceptor for Speech. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the SpeechRestTransport. + + .. code-block:: python + class MyCustomSpeechInterceptor(SpeechRestInterceptor): + def pre_long_running_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_long_running_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + transport = SpeechRestTransport(interceptor=MyCustomSpeechInterceptor()) + client = SpeechClient(transport=transport) + + + """ + def pre_long_running_recognize(self, request: cloud_speech.LongRunningRecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.LongRunningRecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for long_running_recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_long_running_recognize(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for long_running_recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_recognize(self, request: cloud_speech.RecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.RecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_recognize(self, response: cloud_speech.RecognizeResponse) -> cloud_speech.RecognizeResponse: + """Post-rpc interceptor for recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class SpeechRestStub: + _session: AuthorizedSession + _host: str + _interceptor: SpeechRestInterceptor + + +class SpeechRestTransport(SpeechTransport): + """REST backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[SpeechRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or SpeechRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v1p1beta1/operations/{name=**}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v1p1beta1/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p1beta1") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _LongRunningRecognize(SpeechRestStub): + def __hash__(self): + return hash("LongRunningRecognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.LongRunningRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the long running recognize method over HTTP. + + Args: + request (~.cloud_speech.LongRunningRecognizeRequest): + The request object. The top-level message sent by the client for the + ``LongRunningRecognize`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1p1beta1/speech:longrunningrecognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_long_running_recognize(request, metadata) + pb_request = cloud_speech.LongRunningRecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_long_running_recognize(resp) + return resp + + class _Recognize(SpeechRestStub): + def __hash__(self): + return hash("Recognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.RecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.RecognizeResponse: + r"""Call the recognize method over HTTP. + + Args: + request (~.cloud_speech.RecognizeRequest): + The request object. The top-level message sent by the client for the + ``Recognize`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.RecognizeResponse: + The only message returned to the client by the + ``Recognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1p1beta1/speech:recognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_recognize(request, metadata) + pb_request = cloud_speech.RecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.RecognizeResponse() + pb_resp = cloud_speech.RecognizeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_recognize(resp) + return resp + + class _StreamingRecognize(SpeechRestStub): + def __hash__(self): + return hash("StreamingRecognize") + + def __call__(self, + request: cloud_speech.StreamingRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> rest_streaming.ResponseIterator: + raise NotImplementedError( + "Method StreamingRecognize is not available over REST transport" + ) + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._LongRunningRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._Recognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._StreamingRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(SpeechRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/operations/{name=**}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(SpeechRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1p1beta1/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'SpeechRestTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py new file mode 100644 index 00000000..54ce2fc6 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .cloud_speech import ( + LongRunningRecognizeMetadata, + LongRunningRecognizeRequest, + LongRunningRecognizeResponse, + RecognitionAudio, + RecognitionConfig, + RecognitionMetadata, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechAdaptationInfo, + SpeechContext, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + TranscriptOutputConfig, + WordInfo, +) +from .cloud_speech_adaptation import ( + CreateCustomClassRequest, + CreatePhraseSetRequest, + DeleteCustomClassRequest, + DeletePhraseSetRequest, + GetCustomClassRequest, + GetPhraseSetRequest, + ListCustomClassesRequest, + ListCustomClassesResponse, + ListPhraseSetRequest, + ListPhraseSetResponse, + UpdateCustomClassRequest, + UpdatePhraseSetRequest, +) +from .resource import ( + CustomClass, + PhraseSet, + SpeechAdaptation, + TranscriptNormalization, +) + +__all__ = ( + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptationInfo', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', + 'TranscriptNormalization', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py new file mode 100644 index 00000000..a7f1a7a9 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py @@ -0,0 +1,1575 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'RecognizeRequest', + 'LongRunningRecognizeRequest', + 'TranscriptOutputConfig', + 'StreamingRecognizeRequest', + 'StreamingRecognitionConfig', + 'RecognitionConfig', + 'SpeakerDiarizationConfig', + 'RecognitionMetadata', + 'SpeechContext', + 'RecognitionAudio', + 'RecognizeResponse', + 'LongRunningRecognizeResponse', + 'LongRunningRecognizeMetadata', + 'StreamingRecognizeResponse', + 'StreamingRecognitionResult', + 'SpeechRecognitionResult', + 'SpeechRecognitionAlternative', + 'WordInfo', + 'SpeechAdaptationInfo', + }, +) + + +class RecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the ``Recognize`` + method. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be recognized. + """ + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio: 'RecognitionAudio' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + + +class LongRunningRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``LongRunningRecognize`` method. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be recognized. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Optional. Specifies an optional destination + for the recognition results. + """ + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio: 'RecognitionAudio' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + output_config: 'TranscriptOutputConfig' = proto.Field( + proto.MESSAGE, + number=4, + message='TranscriptOutputConfig', + ) + + +class TranscriptOutputConfig(proto.Message): + r"""Specifies an optional destination for the recognition + results. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + gcs_uri (str): + Specifies a Cloud Storage URI for the recognition results. + Must be specified in the format: + ``gs://bucket_name/object_name``, and the bucket must + already exist. + + This field is a member of `oneof`_ ``output_type``. + """ + + gcs_uri: str = proto.Field( + proto.STRING, + number=1, + oneof='output_type', + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The first message + must contain a ``streaming_config`` message and must not contain + ``audio_content``. All subsequent messages must contain + ``audio_content`` and must not contain a ``streaming_config`` + message. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + streaming_config (google.cloud.speech_v1p1beta1.types.StreamingRecognitionConfig): + Provides information to the recognizer that specifies how to + process the request. The first ``StreamingRecognizeRequest`` + message must contain a ``streaming_config`` message. + + This field is a member of `oneof`_ ``streaming_request``. + audio_content (bytes): + The audio data to be recognized. Sequential chunks of audio + data are sent in sequential ``StreamingRecognizeRequest`` + messages. The first ``StreamingRecognizeRequest`` message + must not contain ``audio_content`` data and all subsequent + ``StreamingRecognizeRequest`` messages must contain + ``audio_content`` data. The audio bytes must be encoded as + specified in ``RecognitionConfig``. Note: as with all bytes + fields, proto buffers use a pure binary representation (not + base64). See `content + limits `__. + + This field is a member of `oneof`_ ``streaming_request``. + """ + + streaming_config: 'StreamingRecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + oneof='streaming_request', + message='StreamingRecognitionConfig', + ) + audio_content: bytes = proto.Field( + proto.BYTES, + number=2, + oneof='streaming_request', + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + single_utterance (bool): + If ``false`` or omitted, the recognizer will perform + continuous recognition (continuing to wait for and process + audio even if the user pauses speaking) until the client + closes the input stream (gRPC API) or until the maximum time + limit has been reached. May return multiple + ``StreamingRecognitionResult``\ s with the ``is_final`` flag + set to ``true``. + + If ``true``, the recognizer will detect a single spoken + utterance. When it detects that the user has paused or + stopped speaking, it will return an + ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It + will return no more than one ``StreamingRecognitionResult`` + with the ``is_final`` flag set to ``true``. + + The ``single_utterance`` field can only be used with + specified models, otherwise an error is thrown. The + ``model`` field in [``RecognitionConfig``][] must be set to: + + - ``command_and_search`` + - ``phone_call`` AND additional field + ``useEnhanced``\ =\ ``true`` + - The ``model`` field is left undefined. In this case the + API auto-selects a model based on any other parameters + that you set in ``RecognitionConfig``. + interim_results (bool): + If ``true``, interim results (tentative hypotheses) may be + returned as they become available (these interim results are + indicated with the ``is_final=false`` flag). If ``false`` or + omitted, only ``is_final=true`` result(s) are returned. + enable_voice_activity_events (bool): + If ``true``, responses with voice activity speech events + will be returned as they are detected. + voice_activity_timeout (google.cloud.speech_v1p1beta1.types.StreamingRecognitionConfig.VoiceActivityTimeout): + If set, the server will automatically close the stream after + the specified duration has elapsed after the last + VOICE_ACTIVITY speech event has been sent. The field + ``voice_activity_events`` must also be set to true. + """ + + class VoiceActivityTimeout(proto.Message): + r"""Events that a timeout can be set on for voice activity. + + Attributes: + speech_start_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream if no speech + begins. + speech_end_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream after speech + ends. + """ + + speech_start_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + speech_end_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + single_utterance: bool = proto.Field( + proto.BOOL, + number=2, + ) + interim_results: bool = proto.Field( + proto.BOOL, + number=3, + ) + enable_voice_activity_events: bool = proto.Field( + proto.BOOL, + number=5, + ) + voice_activity_timeout: VoiceActivityTimeout = proto.Field( + proto.MESSAGE, + number=6, + message=VoiceActivityTimeout, + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + encoding (google.cloud.speech_v1p1beta1.types.RecognitionConfig.AudioEncoding): + Encoding of audio data sent in all ``RecognitionAudio`` + messages. This field is optional for ``FLAC`` and ``WAV`` + audio files and required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent in all + ``RecognitionAudio`` messages. Valid values are: 8000-48000. + 16000 is optimal. For best results, set the sampling rate of + the audio source to 16000 Hz. If that's not possible, use + the native sample rate of the audio source (instead of + re-sampling). This field is optional for FLAC and WAV audio + files, but is required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. + audio_channel_count (int): + The number of channels in the input audio data. ONLY set + this for MULTI-CHANNEL recognition. Valid values for + LINEAR16, OGG_OPUS and FLAC are ``1``-``8``. Valid value for + MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only ``1``. + If ``0`` or omitted, defaults to one channel (mono). Note: + We only recognize the first channel by default. To perform + independent recognition on each channel set + ``enable_separate_recognition_per_channel`` to 'true'. + enable_separate_recognition_per_channel (bool): + This needs to be set to ``true`` explicitly and + ``audio_channel_count`` > 1 to get each channel recognized + separately. The recognition result will contain a + ``channel_tag`` field to state which channel that result + belongs to. If this is not true, we will only recognize the + first channel. The request is billed cumulatively for all + channels recognized: ``audio_channel_count`` multiplied by + the length of the audio. + language_code (str): + Required. The language of the supplied audio as a + `BCP-47 `__ + language tag. Example: "en-US". See `Language + Support `__ + for a list of the currently supported language codes. + alternative_language_codes (MutableSequence[str]): + A list of up to 3 additional + `BCP-47 `__ + language tags, listing possible alternative languages of the + supplied audio. See `Language + Support `__ + for a list of the currently supported language codes. If + alternative languages are listed, recognition result will + contain recognition in the most likely language detected + including the main language_code. The recognition result + will include the language tag of the language detected in + the audio. Note: This feature is only supported for Voice + Command and Voice Search use cases and performance may vary + for other use cases (e.g., phone call transcription). + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. + Specifically, the maximum number of + ``SpeechRecognitionAlternative`` messages within each + ``SpeechRecognitionResult``. The server may return fewer + than ``max_alternatives``. Valid values are ``0``-``30``. A + value of ``0`` or ``1`` will return a maximum of one. If + omitted, will return a maximum of one. + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, e.g. "f***". If set to + ``false`` or omitted, profanities won't be filtered out. + adaptation (google.cloud.speech_v1p1beta1.types.SpeechAdaptation): + Speech adaptation configuration improves the accuracy of + speech recognition. For more information, see the `speech + adaptation `__ + documentation. When speech adaptation is set it supersedes + the ``speech_contexts`` field. + transcript_normalization (google.cloud.speech_v1p1beta1.types.TranscriptNormalization): + Use transcription normalization to + automatically replace parts of the transcript + with phrases of your choosing. For + StreamingRecognize, this normalization only + applies to stable partial transcripts (stability + > 0.8) and final transcripts. + speech_contexts (MutableSequence[google.cloud.speech_v1p1beta1.types.SpeechContext]): + Array of + [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. + A means to provide context to assist the speech recognition. + For more information, see `speech + adaptation `__. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_word_confidence (bool): + If ``true``, the top result includes a list of words and the + confidence for those words. If ``false``, no word-level + confidence information is returned. The default is + ``false``. + enable_automatic_punctuation (bool): + If 'true', adds punctuation to recognition + result hypotheses. This feature is only + available in select languages. Setting this for + requests in other languages has no effect at + all. The default 'false' value does not add + punctuation to result hypotheses. + enable_spoken_punctuation (google.protobuf.wrappers_pb2.BoolValue): + The spoken punctuation behavior for the call If not set, + uses default behavior based on model of choice e.g. + command_and_search will enable spoken punctuation by default + If 'true', replaces spoken punctuation with the + corresponding symbols in the request. For example, "how are + you question mark" becomes "how are you?". See + https://cloud.google.com/speech-to-text/docs/spoken-punctuation + for support. If 'false', spoken punctuation is not replaced. + enable_spoken_emojis (google.protobuf.wrappers_pb2.BoolValue): + The spoken emoji behavior for the call + If not set, uses default behavior based on model + of choice If 'true', adds spoken emoji + formatting for the request. This will replace + spoken emojis with the corresponding Unicode + symbols in the final transcript. If 'false', + spoken emojis are not replaced. + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. Note: Use + diarization_config instead. + diarization_speaker_count (int): + If set, specifies the estimated number of speakers in the + conversation. Defaults to '2'. Ignored unless + enable_speaker_diarization is set to true. Note: Use + diarization_config instead. + diarization_config (google.cloud.speech_v1p1beta1.types.SpeakerDiarizationConfig): + Config to enable speaker diarization and set + additional parameters to make diarization better + suited for your application. Note: When this is + enabled, we send all the words from the + beginning of the audio for the top alternative + in every consecutive STREAMING responses. This + is done in order to improve our speaker tags as + our models learn to identify the speakers in the + conversation over time. For non-streaming + requests, the diarization results will be + provided only in the top alternative of the + FINAL SpeechRecognitionResult. + metadata (google.cloud.speech_v1p1beta1.types.RecognitionMetadata): + Metadata regarding this request. + model (str): + Which model to select for the given request. Select the + model best suited to your domain to get best results. If a + model is not explicitly specified, then we auto-select a + model based on the parameters in the RecognitionConfig. + + .. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModelDescription
latest_longBest for long form content like media or conversation.
latest_shortBest for short form content like commands or single shot directed + speech.
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically + recorded at an 8khz sampling rate).
videoBest for audio that originated from video or includes multiple + speakers. Ideally the audio is recorded at a 16khz or greater + sampling rate. This is a premium model that costs more than the + standard rate.
defaultBest for audio that is not one of the specific audio models. + For example, long-form audio. Ideally the audio is high-fidelity, + recorded at a 16khz or greater sampling rate.
medical_conversationBest for audio that originated from a conversation between a + medical provider and patient.
medical_dictationBest for audio that originated from dictation notes by a medical + provider.
+ use_enhanced (bool): + Set to true to use an enhanced model for speech recognition. + If ``use_enhanced`` is set to true and the ``model`` field + is not set, then an appropriate enhanced model is chosen if + an enhanced model exists for the audio. + + If ``use_enhanced`` is true and an enhanced version of the + specified model does not exist, then the speech is + recognized using the standard version of the specified + model. + """ + class AudioEncoding(proto.Enum): + r"""The encoding of the audio data sent in the request. + + All encodings support only 1 channel (mono) audio, unless the + ``audio_channel_count`` and + ``enable_separate_recognition_per_channel`` fields are set. + + For best results, the audio source should be captured and + transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). + The accuracy of the speech recognition can be reduced if lossy + codecs are used to capture or transmit audio, particularly if + background noise is present. Lossy codecs include ``MULAW``, + ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, + ``MP3``, and ``WEBM_OPUS``. + + The ``FLAC`` and ``WAV`` audio file formats include a header that + describes the included audio content. You can request recognition + for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` + encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in + your request, you do not need to specify an ``AudioEncoding``; the + audio encoding format is determined from the file header. If you + specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` + audio, the encoding configuration must match the encoding described + in the audio header; otherwise the request returns an + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] + error code. + + Values: + ENCODING_UNSPECIFIED (0): + Not specified. + LINEAR16 (1): + Uncompressed 16-bit signed little-endian + samples (Linear PCM). + FLAC (2): + ``FLAC`` (Free Lossless Audio Codec) is the recommended + encoding because it is lossless--therefore recognition is + not compromised--and requires only about half the bandwidth + of ``LINEAR16``. ``FLAC`` stream encoding supports 16-bit + and 24-bit samples, however, not all fields in + ``STREAMINFO`` are supported. + MULAW (3): + 8-bit samples that compand 14-bit audio + samples using G.711 PCMU/mu-law. + AMR (4): + Adaptive Multi-Rate Narrowband codec. ``sample_rate_hertz`` + must be 8000. + AMR_WB (5): + Adaptive Multi-Rate Wideband codec. ``sample_rate_hertz`` + must be 16000. + OGG_OPUS (6): + Opus encoded audio frames in Ogg container + (`OggOpus `__). + ``sample_rate_hertz`` must be one of 8000, 12000, 16000, + 24000, or 48000. + SPEEX_WITH_HEADER_BYTE (7): + Although the use of lossy encodings is not recommended, if a + very low bitrate encoding is required, ``OGG_OPUS`` is + highly preferred over Speex encoding. The + `Speex `__ encoding supported by Cloud + Speech API has a header byte in each block, as in MIME type + ``audio/x-speex-with-header-byte``. It is a variant of the + RTP Speex encoding defined in `RFC + 5574 `__. The stream is + a sequence of blocks, one block per RTP packet. Each block + starts with a byte containing the length of the block, in + bytes, followed by one or more frames of Speex data, padded + to an integral number of bytes (octets) as specified in RFC + 5574. In other words, each RTP header is replaced with a + single byte containing the block length. Only Speex wideband + is supported. ``sample_rate_hertz`` must be 16000. + MP3 (8): + MP3 audio. MP3 encoding is a Beta feature and only available + in v1p1beta1. Support all standard MP3 bitrates (which range + from 32-320 kbps). When using this encoding, + ``sample_rate_hertz`` has to match the sample rate of the + file being used. + WEBM_OPUS (9): + Opus encoded audio frames in WebM container + (`OggOpus `__). + ``sample_rate_hertz`` must be one of 8000, 12000, 16000, + 24000, or 48000. + """ + ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + FLAC = 2 + MULAW = 3 + AMR = 4 + AMR_WB = 5 + OGG_OPUS = 6 + SPEEX_WITH_HEADER_BYTE = 7 + MP3 = 8 + WEBM_OPUS = 9 + + encoding: AudioEncoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz: int = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count: int = proto.Field( + proto.INT32, + number=7, + ) + enable_separate_recognition_per_channel: bool = proto.Field( + proto.BOOL, + number=12, + ) + language_code: str = proto.Field( + proto.STRING, + number=3, + ) + alternative_language_codes: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=18, + ) + max_alternatives: int = proto.Field( + proto.INT32, + number=4, + ) + profanity_filter: bool = proto.Field( + proto.BOOL, + number=5, + ) + adaptation: resource.SpeechAdaptation = proto.Field( + proto.MESSAGE, + number=20, + message=resource.SpeechAdaptation, + ) + transcript_normalization: resource.TranscriptNormalization = proto.Field( + proto.MESSAGE, + number=24, + message=resource.TranscriptNormalization, + ) + speech_contexts: MutableSequence['SpeechContext'] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='SpeechContext', + ) + enable_word_time_offsets: bool = proto.Field( + proto.BOOL, + number=8, + ) + enable_word_confidence: bool = proto.Field( + proto.BOOL, + number=15, + ) + enable_automatic_punctuation: bool = proto.Field( + proto.BOOL, + number=11, + ) + enable_spoken_punctuation: wrappers_pb2.BoolValue = proto.Field( + proto.MESSAGE, + number=22, + message=wrappers_pb2.BoolValue, + ) + enable_spoken_emojis: wrappers_pb2.BoolValue = proto.Field( + proto.MESSAGE, + number=23, + message=wrappers_pb2.BoolValue, + ) + enable_speaker_diarization: bool = proto.Field( + proto.BOOL, + number=16, + ) + diarization_speaker_count: int = proto.Field( + proto.INT32, + number=17, + ) + diarization_config: 'SpeakerDiarizationConfig' = proto.Field( + proto.MESSAGE, + number=19, + message='SpeakerDiarizationConfig', + ) + metadata: 'RecognitionMetadata' = proto.Field( + proto.MESSAGE, + number=9, + message='RecognitionMetadata', + ) + model: str = proto.Field( + proto.STRING, + number=13, + ) + use_enhanced: bool = proto.Field( + proto.BOOL, + number=14, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Config to enable speaker diarization. + + Attributes: + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. + min_speaker_count (int): + Minimum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 2. + max_speaker_count (int): + Maximum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 6. + speaker_tag (int): + Output only. Unused. + """ + + enable_speaker_diarization: bool = proto.Field( + proto.BOOL, + number=1, + ) + min_speaker_count: int = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count: int = proto.Field( + proto.INT32, + number=3, + ) + speaker_tag: int = proto.Field( + proto.INT32, + number=5, + ) + + +class RecognitionMetadata(proto.Message): + r"""Description of audio data to be recognized. + + Attributes: + interaction_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.InteractionType): + The use case most closely describing the + audio content to be recognized. + industry_naics_code_of_audio (int): + The industry vertical to which this speech + recognition request most closely applies. This + is most indicative of the topics contained in + the audio. Use the 6-digit NAICS code to + identify the industry vertical - see + https://www.naics.com/search/. + microphone_distance (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.MicrophoneDistance): + The audio type that most closely describes + the audio being recognized. + original_media_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.OriginalMediaType): + The original media the speech was recorded + on. + recording_device_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.RecordingDeviceType): + The type of device the speech was recorded + with. + recording_device_name (str): + The device used to make the recording. + Examples 'Nexus 5X' or 'Polycom SoundStation IP + 6000' or 'POTS' or 'VoIP' or 'Cardioid + Microphone'. + original_mime_type (str): + Mime type of the original audio file. For example + ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, + ``audio/3gpp``. A list of possible audio mime types is + maintained at + http://www.iana.org/assignments/media-types/media-types.xhtml#audio + obfuscated_id (int): + Obfuscated (privacy-protected) ID of the + user, to identify number of unique users using + the service. + audio_topic (str): + Description of the content. Eg. "Recordings + of federal supreme court hearings from 2012". + """ + class InteractionType(proto.Enum): + r"""Use case categories that the audio recognition request can be + described by. + + Values: + INTERACTION_TYPE_UNSPECIFIED (0): + Use case is either unknown or is something + other than one of the other values below. + DISCUSSION (1): + Multiple people in a conversation or discussion. For example + in a meeting with two or more people actively participating. + Typically all the primary people speaking would be in the + same room (if not, see PHONE_CALL) + PRESENTATION (2): + One or more persons lecturing or presenting + to others, mostly uninterrupted. + PHONE_CALL (3): + A phone-call or video-conference in which two + or more people, who are not in the same room, + are actively participating. + VOICEMAIL (4): + A recorded message intended for another + person to listen to. + PROFESSIONALLY_PRODUCED (5): + Professionally produced audio (eg. TV Show, + Podcast). + VOICE_SEARCH (6): + Transcribe spoken questions and queries into + text. + VOICE_COMMAND (7): + Transcribe voice commands, such as for + controlling a device. + DICTATION (8): + Transcribe speech to text to create a written + document, such as a text-message, email or + report. + """ + INTERACTION_TYPE_UNSPECIFIED = 0 + DISCUSSION = 1 + PRESENTATION = 2 + PHONE_CALL = 3 + VOICEMAIL = 4 + PROFESSIONALLY_PRODUCED = 5 + VOICE_SEARCH = 6 + VOICE_COMMAND = 7 + DICTATION = 8 + + class MicrophoneDistance(proto.Enum): + r"""Enumerates the types of capture settings describing an audio + file. + + Values: + MICROPHONE_DISTANCE_UNSPECIFIED (0): + Audio type is not known. + NEARFIELD (1): + The audio was captured from a closely placed + microphone. Eg. phone, dictaphone, or handheld + microphone. Generally if there speaker is within + 1 meter of the microphone. + MIDFIELD (2): + The speaker if within 3 meters of the + microphone. + FARFIELD (3): + The speaker is more than 3 meters away from + the microphone. + """ + MICROPHONE_DISTANCE_UNSPECIFIED = 0 + NEARFIELD = 1 + MIDFIELD = 2 + FARFIELD = 3 + + class OriginalMediaType(proto.Enum): + r"""The original media the speech was recorded on. + + Values: + ORIGINAL_MEDIA_TYPE_UNSPECIFIED (0): + Unknown original media type. + AUDIO (1): + The speech data is an audio recording. + VIDEO (2): + The speech data originally recorded on a + video. + """ + ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 + AUDIO = 1 + VIDEO = 2 + + class RecordingDeviceType(proto.Enum): + r"""The type of device the speech was recorded with. + + Values: + RECORDING_DEVICE_TYPE_UNSPECIFIED (0): + The recording device is unknown. + SMARTPHONE (1): + Speech was recorded on a smartphone. + PC (2): + Speech was recorded using a personal computer + or tablet. + PHONE_LINE (3): + Speech was recorded over a phone line. + VEHICLE (4): + Speech was recorded in a vehicle. + OTHER_OUTDOOR_DEVICE (5): + Speech was recorded outdoors. + OTHER_INDOOR_DEVICE (6): + Speech was recorded indoors. + """ + RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 + SMARTPHONE = 1 + PC = 2 + PHONE_LINE = 3 + VEHICLE = 4 + OTHER_OUTDOOR_DEVICE = 5 + OTHER_INDOOR_DEVICE = 6 + + interaction_type: InteractionType = proto.Field( + proto.ENUM, + number=1, + enum=InteractionType, + ) + industry_naics_code_of_audio: int = proto.Field( + proto.UINT32, + number=3, + ) + microphone_distance: MicrophoneDistance = proto.Field( + proto.ENUM, + number=4, + enum=MicrophoneDistance, + ) + original_media_type: OriginalMediaType = proto.Field( + proto.ENUM, + number=5, + enum=OriginalMediaType, + ) + recording_device_type: RecordingDeviceType = proto.Field( + proto.ENUM, + number=6, + enum=RecordingDeviceType, + ) + recording_device_name: str = proto.Field( + proto.STRING, + number=7, + ) + original_mime_type: str = proto.Field( + proto.STRING, + number=8, + ) + obfuscated_id: int = proto.Field( + proto.INT64, + number=9, + ) + audio_topic: str = proto.Field( + proto.STRING, + number=10, + ) + + +class SpeechContext(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + phrases (MutableSequence[str]): + A list of strings containing words and phrases "hints" so + that the speech recognition is more likely to recognize + them. This can be used to improve the accuracy for specific + words and phrases, for example, if specific commands are + typically spoken by the user. This can also be used to add + additional words to the vocabulary of the recognizer. See + `usage + limits `__. + + List items can also be set to classes for groups of words + that represent common concepts that occur in natural + language. For example, rather than providing phrase hints + for every month of the year, using the $MONTH class improves + the likelihood of correctly transcribing audio that includes + months. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. + """ + + phrases: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + boost: float = proto.Field( + proto.FLOAT, + number=4, + ) + + +class RecognitionAudio(proto.Message): + r"""Contains audio data in the encoding specified in the + ``RecognitionConfig``. Either ``content`` or ``uri`` must be + supplied. Supplying both or neither returns + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + content (bytes): + The audio data bytes encoded as specified in + ``RecognitionConfig``. Note: as with all bytes fields, proto + buffers use a pure binary representation, whereas JSON + representations use base64. + + This field is a member of `oneof`_ ``audio_source``. + uri (str): + URI that points to a file that contains audio data bytes as + specified in ``RecognitionConfig``. The file must not be + compressed (for example, gzip). Currently, only Google Cloud + Storage URIs are supported, which must be specified in the + following format: ``gs://bucket_name/object_name`` (other + URI formats return + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + + This field is a member of `oneof`_ ``audio_source``. + """ + + content: bytes = proto.Field( + proto.BYTES, + number=1, + oneof='audio_source', + ) + uri: str = proto.Field( + proto.STRING, + number=2, + oneof='audio_source', + ) + + +class RecognizeResponse(proto.Message): + r"""The only message returned to the client by the ``Recognize`` method. + It contains the result as zero or more sequential + ``SpeechRecognitionResult`` messages. + + Attributes: + results (MutableSequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + speech_adaptation_info (google.cloud.speech_v1p1beta1.types.SpeechAdaptationInfo): + Provides information on adaptation behavior + in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=3, + message=duration_pb2.Duration, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=7, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=8, + ) + + +class LongRunningRecognizeResponse(proto.Message): + r"""The only message returned to the client by the + ``LongRunningRecognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. It is included + in the ``result.response`` field of the ``Operation`` returned by + the ``GetOperation`` call of the ``google::longrunning::Operations`` + service. + + Attributes: + results (MutableSequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Original output config if present in the + request. + output_error (google.rpc.status_pb2.Status): + If the transcript output fails this field + contains the relevant error. + speech_adaptation_info (google.cloud.speech_v1p1beta1.types.SpeechAdaptationInfo): + Provides information on speech adaptation + behavior in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=3, + message=duration_pb2.Duration, + ) + output_config: 'TranscriptOutputConfig' = proto.Field( + proto.MESSAGE, + number=6, + message='TranscriptOutputConfig', + ) + output_error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=7, + message=status_pb2.Status, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=8, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=9, + ) + + +class LongRunningRecognizeMetadata(proto.Message): + r"""Describes the progress of a long-running ``LongRunningRecognize`` + call. It is included in the ``metadata`` field of the ``Operation`` + returned by the ``GetOperation`` call of the + ``google::longrunning::Operations`` service. + + Attributes: + progress_percent (int): + Approximate percentage of audio processed + thus far. Guaranteed to be 100 when the audio is + fully processed and the results are available. + start_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the request was received. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time of the most recent processing update. + uri (str): + Output only. The URI of the audio file being + transcribed. Empty if the audio was sent as byte + content. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Output only. A copy of the + TranscriptOutputConfig if it was set in the + request. + """ + + progress_percent: int = proto.Field( + proto.INT32, + number=1, + ) + start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + last_update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + uri: str = proto.Field( + proto.STRING, + number=4, + ) + output_config: 'TranscriptOutputConfig' = proto.Field( + proto.MESSAGE, + number=5, + message='TranscriptOutputConfig', + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``StreamingRecognizeResponse`` is the only message returned to the + client by ``StreamingRecognize``. A series of zero or more + ``StreamingRecognizeResponse`` messages are streamed back to the + client. If there is no recognizable audio, and ``single_utterance`` + is set to false, then no messages are streamed back to the client. + + Here's an example of a series of ``StreamingRecognizeResponse``\ s + that might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. results { alternatives { transcript: " that is the question" + confidence: 0.98 } alternatives { transcript: " that was the + question" } is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain final results; + they are indicated by ``is_final: true``. Concatenating these + together generates the full transcript: "to be or not to be that + is the question". + + - The others contain interim ``results``. #3 and #6 contain two + interim ``results``: the first portion has a high stability and + is less likely to change; the second portion has a low stability + and is very likely to change. A UI designer might choose to show + only high stability ``results``. + + - The specific ``stability`` and ``confidence`` values shown above + are only for illustrative purposes. Actual values may vary. + + - In each response, only one of these fields will be set: + ``error``, ``speech_event_type``, or one or more (repeated) + ``results``. + + Attributes: + error (google.rpc.status_pb2.Status): + If set, returns a [google.rpc.Status][google.rpc.Status] + message that specifies the error for the operation. + results (MutableSequence[google.cloud.speech_v1p1beta1.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one ``is_final=true`` + result (the newly settled portion), followed by zero or more + ``is_final=false`` results (the interim results). + speech_event_type (google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + speech_event_time (google.protobuf.duration_pb2.Duration): + Time offset between the beginning of the + audio and event emission. + total_billed_time (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + stream. Set only if this is the last response in + the stream. + speech_adaptation_info (google.cloud.speech_v1p1beta1.types.SpeechAdaptationInfo): + Provides information on adaptation behavior + in response + request_id (int): + The ID associated with the request. This is a + unique ID specific only to the given request. + """ + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event. + + Values: + SPEECH_EVENT_UNSPECIFIED (0): + No speech event specified. + END_OF_SINGLE_UTTERANCE (1): + This event indicates that the server has detected the end of + the user's speech utterance and expects no additional + speech. Therefore, the server will not process additional + audio (although it may subsequently return additional + results). The client should stop sending additional audio + data, half-close the gRPC connection, and wait for any + additional results until the server closes the gRPC + connection. This event is only sent if ``single_utterance`` + was set to ``true``, and is not used otherwise. + SPEECH_ACTIVITY_BEGIN (2): + This event indicates that the server has detected the + beginning of human voice activity in the stream. This event + can be returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + SPEECH_ACTIVITY_END (3): + This event indicates that the server has detected the end of + human voice activity in the stream. This event can be + returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + SPEECH_ACTIVITY_TIMEOUT (4): + This event indicates that the user-set + timeout for speech activity begin or end has + exceeded. Upon receiving this event, the client + is expected to send a half close. Further audio + will not be processed. + """ + SPEECH_EVENT_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + SPEECH_ACTIVITY_BEGIN = 2 + SPEECH_ACTIVITY_END = 3 + SPEECH_ACTIVITY_TIMEOUT = 4 + + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + results: MutableSequence['StreamingRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='StreamingRecognitionResult', + ) + speech_event_type: SpeechEventType = proto.Field( + proto.ENUM, + number=4, + enum=SpeechEventType, + ) + speech_event_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=8, + message=duration_pb2.Duration, + ) + total_billed_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=5, + message=duration_pb2.Duration, + ) + speech_adaptation_info: 'SpeechAdaptationInfo' = proto.Field( + proto.MESSAGE, + number=9, + message='SpeechAdaptationInfo', + ) + request_id: int = proto.Field( + proto.INT64, + number=10, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + is_final (bool): + If ``false``, this ``StreamingRecognitionResult`` represents + an interim result that may change. If ``true``, this is the + final time the speech service will return this particular + ``StreamingRecognitionResult``, the recognizer will not + return any further hypotheses for this portion of the + transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + (``is_final=false``). The default of 0.0 is a sentinel value + indicating ``stability`` was not set. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + is_final: bool = proto.Field( + proto.BOOL, + number=2, + ) + stability: float = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag: int = proto.Field( + proto.INT32, + number=5, + ) + language_code: str = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + channel_tag: int = proto.Field( + proto.INT32, + number=2, + ) + result_end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + language_code: str = proto.Field( + proto.STRING, + number=5, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. In languages that use spaces to + separate words, the transcript might have a + leading space if it isn't the first result. You + can concatenate each result to obtain the full + transcript without using a separator. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (MutableSequence[google.cloud.speech_v1p1beta1.types.WordInfo]): + A list of word-specific information for each recognized + word. Note: When ``enable_speaker_diarization`` is true, you + will see all the words from the beginning of the audio. + """ + + transcript: str = proto.Field( + proto.STRING, + number=1, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=2, + ) + words: MutableSequence['WordInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='WordInfo', + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + + Attributes: + start_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + end_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + word (str): + The word corresponding to this set of + information. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + speaker_tag (int): + Output only. A distinct integer value is assigned for every + speaker within the audio. This field specifies which one of + those speakers was detected to have spoken this word. Value + ranges from '1' to diarization_speaker_count. speaker_tag is + set if enable_speaker_diarization = 'true' and only in the + top alternative. + """ + + start_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_time: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word: str = proto.Field( + proto.STRING, + number=3, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=4, + ) + speaker_tag: int = proto.Field( + proto.INT32, + number=5, + ) + + +class SpeechAdaptationInfo(proto.Message): + r"""Information on speech adaptation use in results + + Attributes: + adaptation_timeout (bool): + Whether there was a timeout when applying + speech adaptation. If true, adaptation had no + effect in the response transcript. + timeout_message (str): + If set, returns a message specifying which + part of the speech adaptation request timed out. + """ + + adaptation_timeout: bool = proto.Field( + proto.BOOL, + number=1, + ) + timeout_message: str = proto.Field( + proto.STRING, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py new file mode 100644 index 00000000..dd127914 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py @@ -0,0 +1,423 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'CreatePhraseSetRequest', + 'UpdatePhraseSetRequest', + 'GetPhraseSetRequest', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'DeletePhraseSetRequest', + 'CreateCustomClassRequest', + 'UpdateCustomClassRequest', + 'GetCustomClassRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'DeleteCustomClassRequest', + }, +) + + +class CreatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``CreatePhraseSet`` method. + + Attributes: + parent (str): + Required. The parent resource where this phrase set will be + created. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + phrase_set_id (str): + Required. The ID to use for the phrase set, + which will become the final component of the + phrase set's resource name. + + This value should restrict to letters, numbers, + and hyphens, with the first character a letter, + the last a letter or a number, and be 4-63 + characters. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + phrase_set_id: str = proto.Field( + proto.STRING, + number=2, + ) + phrase_set: resource.PhraseSet = proto.Field( + proto.MESSAGE, + number=3, + message=resource.PhraseSet, + ) + + +class UpdatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``UpdatePhraseSet`` method. + + Attributes: + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the set + to be updated. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + phrase_set: resource.PhraseSet = proto.Field( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``GetPhraseSet`` method. + + Attributes: + name (str): + Required. The name of the phrase set to retrieve. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``ListPhraseSet`` method. + + Attributes: + parent (str): + Required. The parent, which owns this collection of phrase + set. Format: + + ``projects/{project}/locations/{location}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + page_size (int): + The maximum number of phrase sets to return. + The service may return fewer than this value. If + unspecified, at most 50 phrase sets will be + returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListPhraseSet`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListPhraseSet`` must match the call that provided the page + token. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListPhraseSetResponse(proto.Message): + r"""Message returned to the client by the ``ListPhraseSet`` method. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): + The phrase set. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + phrase_sets: MutableSequence[resource.PhraseSet] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeletePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``DeletePhraseSet`` method. + + Attributes: + name (str): + Required. The name of the phrase set to delete. Format: + + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``CreateCustomClass`` method. + + Attributes: + parent (str): + Required. The parent resource where this custom class will + be created. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + custom_class_id (str): + Required. The ID to use for the custom class, + which will become the final component of the + custom class' resource name. + + This value should restrict to letters, numbers, + and hyphens, with the first character a letter, + the last a letter or a number, and be 4-63 + characters. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id: str = proto.Field( + proto.STRING, + number=2, + ) + custom_class: resource.CustomClass = proto.Field( + proto.MESSAGE, + number=3, + message=resource.CustomClass, + ) + + +class UpdateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``UpdateCustomClass`` method. + + Attributes: + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify the + custom class to be updated. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + custom_class: resource.CustomClass = proto.Field( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``GetCustomClass`` method. + + Attributes: + name (str): + Required. The name of the custom class to retrieve. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListCustomClassesRequest(proto.Message): + r"""Message sent by the client for the ``ListCustomClasses`` method. + + Attributes: + parent (str): + Required. The parent, which owns this collection of custom + classes. Format: + + ``projects/{project}/locations/{location}/customClasses`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + page_size (int): + The maximum number of custom classes to + return. The service may return fewer than this + value. If unspecified, at most 50 custom classes + will be returned. The maximum value is 1000; + values above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListCustomClass`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListCustomClass`` must match the call that provided the + page token. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListCustomClassesResponse(proto.Message): + r"""Message returned to the client by the ``ListCustomClasses`` method. + + Attributes: + custom_classes (MutableSequence[google.cloud.speech_v1p1beta1.types.CustomClass]): + The custom classes. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + custom_classes: MutableSequence[resource.CustomClass] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``DeleteCustomClass`` method. + + Attributes: + name (str): + Required. The name of the custom class to delete. Format: + + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + Speech-to-Text supports three locations: ``global``, ``us`` + (US North America), and ``eu`` (Europe). If you are calling + the ``speech.googleapis.com`` endpoint, use the ``global`` + location. To specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py new file mode 100644 index 00000000..2e4c9c84 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py @@ -0,0 +1,283 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', + 'TranscriptNormalization', + }, +) + + +class CustomClass(proto.Message): + r"""A set of words or phrases that represents a common concept + likely to appear in your audio, for example a list of passenger + ship names. CustomClass items can be substituted into + placeholders that you set in PhraseSet phrases. + + Attributes: + name (str): + The resource name of the custom class. + custom_class_id (str): + If this custom class is a resource, the custom_class_id is + the resource id of the CustomClass. Case sensitive. + items (MutableSequence[google.cloud.speech_v1p1beta1.types.CustomClass.ClassItem]): + A collection of class items. + """ + + class ClassItem(proto.Message): + r"""An item of the class. + + Attributes: + value (str): + The class item's value. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id: str = proto.Field( + proto.STRING, + number=2, + ) + items: MutableSequence[ClassItem] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ClassItem, + ) + + +class PhraseSet(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + name (str): + The resource name of the phrase set. + phrases (MutableSequence[google.cloud.speech_v1p1beta1.types.PhraseSet.Phrase]): + A list of word and phrases. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 (exclusive) + and 20. We recommend using a binary search approach to + finding the optimal value for your use case as well as + adding phrases both with and without boost to your requests. + """ + + class Phrase(proto.Message): + r"""A phrases containing words and phrase "hints" so that the speech + recognition is more likely to recognize them. This can be used to + improve the accuracy for specific words and phrases, for example, if + specific commands are typically spoken by the user. This can also be + used to add additional words to the vocabulary of the recognizer. + See `usage + limits `__. + + List items can also include pre-built or custom classes containing + groups of words that represent common concepts that occur in natural + language. For example, rather than providing a phrase hint for every + month of the year (e.g. "i was born in january", "i was born in + febuary", ...), use the pre-built ``$MONTH`` class improves the + likelihood of correctly transcribing audio that includes months + (e.g. "i was born in $month"). To refer to pre-built classes, use + the class' symbol prepended with ``$`` e.g. ``$MONTH``. To refer to + custom classes that were defined inline in the request, set the + class's ``custom_class_id`` to a string unique to all class + resources and inline classes. Then use the class' id wrapped in + $\ ``{...}`` e.g. "${my-months}". To refer to custom classes + resources, use the class' id wrapped in ``${}`` (e.g. + ``${my-months}``). + + Speech-to-Text supports three locations: ``global``, ``us`` (US + North America), and ``eu`` (Europe). If you are calling the + ``speech.googleapis.com`` endpoint, use the ``global`` location. To + specify a region, use a `regional + endpoint `__ + with matching ``us`` or ``eu`` location value. + + Attributes: + value (str): + The phrase itself. + boost (float): + Hint Boost. Overrides the boost set at the phrase set level. + Positive value will increase the probability that a specific + phrase will be recognized over other similar sounding + phrases. The higher the boost, the higher the chance of + false positive recognition as well. Negative boost will + simply be ignored. Though ``boost`` can accept a wide range + of positive values, most use cases are best served with + values between 0 and 20. We recommend using a binary search + approach to finding the optimal value for your use case as + well as adding phrases both with and without boost to your + requests. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + boost: float = proto.Field( + proto.FLOAT, + number=2, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + phrases: MutableSequence[Phrase] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=Phrase, + ) + boost: float = proto.Field( + proto.FLOAT, + number=4, + ) + + +class SpeechAdaptation(proto.Message): + r"""Speech adaptation configuration. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): + A collection of phrase sets. To specify the hints inline, + leave the phrase set's ``name`` blank and fill in the rest + of its fields. Any phrase set can use any custom class. + phrase_set_references (MutableSequence[str]): + A collection of phrase set resource names to + use. + custom_classes (MutableSequence[google.cloud.speech_v1p1beta1.types.CustomClass]): + A collection of custom classes. To specify the classes + inline, leave the class' ``name`` blank and fill in the rest + of its fields, giving it a unique ``custom_class_id``. Refer + to the inline defined class in phrase hints by its + ``custom_class_id``. + abnf_grammar (google.cloud.speech_v1p1beta1.types.SpeechAdaptation.ABNFGrammar): + Augmented Backus-Naur form (ABNF) is a + standardized grammar notation comprised by a set + of derivation rules. See specifications: + https://www.w3.org/TR/speech-grammar + """ + + class ABNFGrammar(proto.Message): + r""" + + Attributes: + abnf_strings (MutableSequence[str]): + All declarations and rules of an ABNF grammar + broken up into multiple strings that will end up + concatenated. + """ + + abnf_strings: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + + phrase_sets: MutableSequence['PhraseSet'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + phrase_set_references: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + custom_classes: MutableSequence['CustomClass'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='CustomClass', + ) + abnf_grammar: ABNFGrammar = proto.Field( + proto.MESSAGE, + number=4, + message=ABNFGrammar, + ) + + +class TranscriptNormalization(proto.Message): + r"""Transcription normalization configuration. Use transcription + normalization to automatically replace parts of the transcript + with phrases of your choosing. For StreamingRecognize, this + normalization only applies to stable partial transcripts + (stability > 0.8) and final transcripts. + + Attributes: + entries (MutableSequence[google.cloud.speech_v1p1beta1.types.TranscriptNormalization.Entry]): + A list of replacement entries. We will perform replacement + with one entry at a time. For example, the second entry in + ["cat" => "dog", "mountain cat" => "mountain dog"] will + never be applied because we will always process the first + entry before it. At most 100 entries. + """ + + class Entry(proto.Message): + r"""A single replacement configuration. + + Attributes: + search (str): + What to replace. Max length is 100 + characters. + replace (str): + What to replace with. Max length is 100 + characters. + case_sensitive (bool): + Whether the search is case sensitive. + """ + + search: str = proto.Field( + proto.STRING, + number=1, + ) + replace: str = proto.Field( + proto.STRING, + number=2, + ) + case_sensitive: bool = proto.Field( + proto.BOOL, + number=3, + ) + + entries: MutableSequence[Entry] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=Entry, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/mypy.ini b/owl-bot-staging/v1p1beta1/mypy.ini new file mode 100644 index 00000000..574c5aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1p1beta1/noxfile.py b/owl-bot-staging/v1p1beta1/noxfile.py new file mode 100644 index 00000000..482df9cb --- /dev/null +++ b/owl-bot-staging/v1p1beta1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/speech_v1p1beta1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==7.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1p1beta1.json b/owl-bot-staging/v1p1beta1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1p1beta1.json new file mode 100644 index 00000000..b51d437c --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/snippet_metadata_google.cloud.speech.v1p1beta1.json @@ -0,0 +1,2152 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.speech.v1p1beta1", + "version": "v1p1beta1" + } + ], + "language": "PYTHON", + "name": "google-cloud-speech", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1p1beta1.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_create_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_CreateCustomClass_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_create_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1p1beta1.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_create_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_CreateCustomClass_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_create_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1p1beta1.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_create_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_create_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1p1beta1.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_create_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_create_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_delete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_delete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_delete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_delete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_delete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_delete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_delete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_delete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_get_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_GetCustomClass_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_get_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_get_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_GetCustomClass_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_get_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_get_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_GetPhraseSet_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_get_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_get_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_GetPhraseSet_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_get_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesAsyncPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v1p1beta1_generated_adaptation_list_custom_classes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_ListCustomClasses_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_list_custom_classes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v1p1beta1_generated_adaptation_list_custom_classes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_ListCustomClasses_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_list_custom_classes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.list_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetAsyncPager", + "shortName": "list_phrase_set" + }, + "description": "Sample for ListPhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_list_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_ListPhraseSet_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_list_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.list_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListPhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "ListPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetPager", + "shortName": "list_phrase_set" + }, + "description": "Sample for ListPhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_list_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_ListPhraseSet_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_list_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1p1beta1.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_update_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_update_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v1p1beta1.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.CustomClass", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v1p1beta1_generated_adaptation_update_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_update_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient", + "shortName": "AdaptationAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationAsyncClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1p1beta1.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_update_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_update_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient", + "shortName": "AdaptationClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.AdaptationClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "Adaptation" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v1p1beta1.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.PhraseSet", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v1p1beta1_generated_adaptation_update_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_adaptation_update_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient.long_running_recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.LongRunningRecognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "LongRunningRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "long_running_recognize" + }, + "description": "Sample for LongRunningRecognize", + "file": "speech_v1p1beta1_generated_speech_long_running_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_LongRunningRecognize_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_long_running_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient.long_running_recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.LongRunningRecognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "LongRunningRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "long_running_recognize" + }, + "description": "Sample for LongRunningRecognize", + "file": "speech_v1p1beta1_generated_speech_long_running_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_LongRunningRecognize_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_long_running_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient.recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.RecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v1p1beta1_generated_speech_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_Recognize_async", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient.recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v1p1beta1.types.RecognizeRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionConfig" + }, + { + "name": "audio", + "type": "google.cloud.speech_v1p1beta1.types.RecognitionAudio" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v1p1beta1.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v1p1beta1_generated_speech_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_Recognize_sync", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechAsyncClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v1p1beta1_generated_speech_streaming_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_StreamingRecognize_async", + "segments": [ + { + "end": 65, + "start": 27, + "type": "FULL" + }, + { + "end": 65, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 58, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 61, + "start": 59, + "type": "REQUEST_EXECUTION" + }, + { + "end": 66, + "start": 62, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_streaming_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v1p1beta1.SpeechClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v1p1beta1.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v1p1beta1_generated_speech_streaming_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v1p1beta1_generated_Speech_StreamingRecognize_sync", + "segments": [ + { + "end": 65, + "start": 27, + "type": "FULL" + }, + { + "end": 65, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 58, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 61, + "start": 59, + "type": "REQUEST_EXECUTION" + }, + { + "end": 66, + "start": 62, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v1p1beta1_generated_speech_streaming_recognize_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_async.py new file mode 100644 index 00000000..a5167d37 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_CreateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_create_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = await client.create_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_CreateCustomClass_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_sync.py new file mode 100644 index 00000000..61db4d20 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_custom_class_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_CreateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_create_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreateCustomClassRequest( + parent="parent_value", + custom_class_id="custom_class_id_value", + ) + + # Make the request + response = client.create_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_CreateCustomClass_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_async.py new file mode 100644 index 00000000..a49eb946 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_create_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = await client.create_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_sync.py new file mode 100644 index 00000000..3c4b8bdf --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_create_phrase_set_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_create_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.CreatePhraseSetRequest( + parent="parent_value", + phrase_set_id="phrase_set_id_value", + ) + + # Make the request + response = client.create_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_CreatePhraseSet_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_async.py new file mode 100644 index 00000000..f18367be --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_delete_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + await client.delete_custom_class(request=request) + + +# [END speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_sync.py new file mode 100644 index 00000000..107c870b --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_custom_class_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_delete_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + client.delete_custom_class(request=request) + + +# [END speech_v1p1beta1_generated_Adaptation_DeleteCustomClass_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_async.py new file mode 100644 index 00000000..8e865d19 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_delete_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + await client.delete_phrase_set(request=request) + + +# [END speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_sync.py new file mode 100644 index 00000000..943e0cf7 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_delete_phrase_set_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_delete_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + client.delete_phrase_set(request=request) + + +# [END speech_v1p1beta1_generated_Adaptation_DeletePhraseSet_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_async.py new file mode 100644 index 00000000..5671627a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_GetCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_get_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_GetCustomClass_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_sync.py new file mode 100644 index 00000000..097da681 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_custom_class_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_GetCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_get_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_GetCustomClass_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_async.py new file mode 100644 index 00000000..699ec9d6 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_GetPhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_get_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_GetPhraseSet_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_sync.py new file mode 100644 index 00000000..6e17b376 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_get_phrase_set_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_GetPhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_get_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_GetPhraseSet_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_async.py new file mode 100644 index 00000000..1d10f6e2 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_ListCustomClasses_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_list_custom_classes(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_ListCustomClasses_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_sync.py new file mode 100644 index 00000000..89226a31 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_custom_classes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_ListCustomClasses_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_list_custom_classes(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_ListCustomClasses_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_async.py new file mode 100644 index 00000000..39475d33 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_ListPhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_list_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_ListPhraseSet_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_sync.py new file mode 100644 index 00000000..0836ab48 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_list_phrase_set_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_ListPhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_list_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.ListPhraseSetRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_set(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_ListPhraseSet_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_async.py new file mode 100644 index 00000000..9b99e0c4 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_update_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdateCustomClassRequest( + ) + + # Make the request + response = await client.update_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_sync.py new file mode 100644 index 00000000..47679a5e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_custom_class_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_update_custom_class(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdateCustomClassRequest( + ) + + # Make the request + response = client.update_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_UpdateCustomClass_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_async.py new file mode 100644 index 00000000..62461462 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_update_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationAsyncClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdatePhraseSetRequest( + ) + + # Make the request + response = await client.update_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_sync.py new file mode 100644 index 00000000..bab3bdde --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_adaptation_update_phrase_set_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_update_phrase_set(): + # Create a client + client = speech_v1p1beta1.AdaptationClient() + + # Initialize request argument(s) + request = speech_v1p1beta1.UpdatePhraseSetRequest( + ) + + # Make the request + response = client.update_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Adaptation_UpdatePhraseSet_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_async.py new file mode 100644 index 00000000..6ffd7543 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for LongRunningRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_LongRunningRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_long_running_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Speech_LongRunningRecognize_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_sync.py new file mode 100644 index 00000000..247d2f0e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_long_running_recognize_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for LongRunningRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_LongRunningRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_long_running_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.LongRunningRecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + operation = client.long_running_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Speech_LongRunningRecognize_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_async.py new file mode 100644 index 00000000..02206e53 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_async.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_Recognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Speech_Recognize_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_sync.py new file mode 100644 index 00000000..2fc2b09a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_recognize_sync.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_Recognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + config = speech_v1p1beta1.RecognitionConfig() + config.language_code = "language_code_value" + + audio = speech_v1p1beta1.RecognitionAudio() + audio.content = b'content_blob' + + request = speech_v1p1beta1.RecognizeRequest( + config=config, + audio=audio, + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v1p1beta1_generated_Speech_Recognize_sync] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_async.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_async.py new file mode 100644 index 00000000..92237e3f --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_async.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_StreamingRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +async def sample_streaming_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechAsyncClient() + + # Initialize request argument(s) + streaming_config = speech_v1p1beta1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1p1beta1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1p1beta1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + +# [END speech_v1p1beta1_generated_Speech_StreamingRecognize_async] diff --git a/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_sync.py b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_sync.py new file mode 100644 index 00000000..6c427c84 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/samples/generated_samples/speech_v1p1beta1_generated_speech_streaming_recognize_sync.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v1p1beta1_generated_Speech_StreamingRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v1p1beta1 + + +def sample_streaming_recognize(): + # Create a client + client = speech_v1p1beta1.SpeechClient() + + # Initialize request argument(s) + streaming_config = speech_v1p1beta1.StreamingRecognitionConfig() + streaming_config.config.language_code = "language_code_value" + + request = speech_v1p1beta1.StreamingRecognizeRequest( + streaming_config=streaming_config, + ) + + # This method expects an iterator which contains + # 'speech_v1p1beta1.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + +# [END speech_v1p1beta1_generated_Speech_StreamingRecognize_sync] diff --git a/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py b/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py new file mode 100644 index 00000000..7c57a5db --- /dev/null +++ b/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py @@ -0,0 +1,188 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_custom_class': ('parent', 'custom_class_id', 'custom_class', ), + 'create_phrase_set': ('parent', 'phrase_set_id', 'phrase_set', ), + 'delete_custom_class': ('name', ), + 'delete_phrase_set': ('name', ), + 'get_custom_class': ('name', ), + 'get_phrase_set': ('name', ), + 'list_custom_classes': ('parent', 'page_size', 'page_token', ), + 'list_phrase_set': ('parent', 'page_size', 'page_token', ), + 'long_running_recognize': ('config', 'audio', 'output_config', ), + 'recognize': ('config', 'audio', ), + 'streaming_recognize': ('streaming_config', 'audio_content', ), + 'update_custom_class': ('custom_class', 'update_mask', ), + 'update_phrase_set': ('phrase_set', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=speechCallTransformer(), +): + """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 speech 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/v1p1beta1/setup.py b/owl-bot-staging/v1p1beta1/setup.py new file mode 100644 index 00000000..06fd97f9 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-speech' + + +description = "Google Cloud Speech API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/speech/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-speech" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.10.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.10.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.11.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.11.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.12.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.12.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.7.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.7.txt new file mode 100644 index 00000000..6c44adfe --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.8.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.8.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1p1beta1/testing/constraints-3.9.txt b/owl-bot-staging/v1p1beta1/testing/constraints-3.9.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v1p1beta1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1p1beta1/tests/__init__.py b/owl-bot-staging/v1p1beta1/tests/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1p1beta1/tests/unit/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1p1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py new file mode 100644 index 00000000..900fe6db --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py @@ -0,0 +1,7011 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationAsyncClient +from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationClient +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.services.adaptation import transports +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert AdaptationClient._get_default_mtls_endpoint(None) is None + assert AdaptationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AdaptationClient, "grpc"), + (AdaptationAsyncClient, "grpc_asyncio"), + (AdaptationClient, "rest"), +]) +def test_adaptation_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.AdaptationGrpcTransport, "grpc"), + (transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.AdaptationRestTransport, "rest"), +]) +def test_adaptation_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AdaptationClient, "grpc"), + (AdaptationAsyncClient, "grpc_asyncio"), + (AdaptationClient, "rest"), +]) +def test_adaptation_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +def test_adaptation_client_get_transport_class(): + transport = AdaptationClient.get_transport_class() + available_transports = [ + transports.AdaptationGrpcTransport, + transports.AdaptationRestTransport, + ] + assert transport in available_transports + + transport = AdaptationClient.get_transport_class("grpc") + assert transport == transports.AdaptationGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (AdaptationClient, transports.AdaptationRestTransport, "rest"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +def test_adaptation_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(AdaptationClient, '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(AdaptationClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "true"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "false"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (AdaptationClient, transports.AdaptationRestTransport, "rest", "true"), + (AdaptationClient, transports.AdaptationRestTransport, "rest", "false"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_adaptation_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + AdaptationClient, AdaptationAsyncClient +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +def test_adaptation_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), + (AdaptationClient, transports.AdaptationRestTransport, "rest"), +]) +def test_adaptation_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", grpc_helpers), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (AdaptationClient, transports.AdaptationRestTransport, "rest", None), +]) +def test_adaptation_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_adaptation_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = AdaptationClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", grpc_helpers), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_adaptation_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_create_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.create_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_create_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_create_phrase_set_async_from_dict(): + await test_create_phrase_set_async(request_type=dict) + + +def test_create_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.create_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.create_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + + +def test_create_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_get_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.get_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + +@pytest.mark.asyncio +async def test_get_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_get_phrase_set_async_from_dict(): + await test_get_phrase_set_async(request_type=dict) + + +def test_get_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.get_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.get_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListPhraseSetRequest, + dict, +]) +def test_list_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + ) + response = client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_set_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + client.list_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + +@pytest.mark.asyncio +async def test_list_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_phrase_set_async_from_dict(): + await test_list_phrase_set_async(request_type=dict) + + +def test_list_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + await client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_phrase_set( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_phrase_set_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_phrase_set( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +def test_list_phrase_set_pager(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_phrase_set(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in results) +def test_list_phrase_set_pages(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = list(client.list_phrase_set(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_phrase_set_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_phrase_set(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_phrase_set_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_phrase_set(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_update_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.update_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_update_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_update_phrase_set_async_from_dict(): + await test_update_phrase_set_async(request_type=dict) + + +def test_update_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +def test_update_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = resource.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_phrase_set_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + client.delete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + +@pytest.mark.asyncio +async def test_delete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async_from_dict(): + await test_delete_phrase_set_async(request_type=dict) + + +def test_delete_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = None + client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_phrase_set_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.create_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + +@pytest.mark.asyncio +async def test_create_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_create_custom_class_async_from_dict(): + await test_create_custom_class_async(request_type=dict) + + +def test_create_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.create_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.create_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + + +def test_create_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetCustomClassRequest, + dict, +]) +def test_get_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_get_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.get_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + +@pytest.mark.asyncio +async def test_get_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_get_custom_class_async_from_dict(): + await test_get_custom_class_async(request_type=dict) + + +def test_get_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.get_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.get_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + response = client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + client.list_custom_classes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + +@pytest.mark.asyncio +async def test_list_custom_classes_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_from_dict(): + await test_list_custom_classes_async(request_type=dict) + + +def test_list_custom_classes_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_custom_classes_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_custom_classes_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_custom_classes_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_pager(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_custom_classes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in results) +def test_list_custom_classes_pages(transport_name: str = "grpc"): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = list(client.list_custom_classes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_custom_classes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_custom_classes(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_update_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.update_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + +@pytest.mark.asyncio +async def test_update_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_update_custom_class_async_from_dict(): + await test_update_custom_class_async(request_type=dict) + + +def test_update_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +def test_update_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = resource.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class(request_type, transport: str = 'grpc'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_custom_class_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 = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + client.delete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + +@pytest.mark.asyncio +async def test_delete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_custom_class_async_from_dict(): + await test_delete_custom_class_async(request_type=dict) + + +def test_delete_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = None + client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_custom_class_flattened_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_create_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["phrase_set_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + jsonified_request["phraseSetId"] = 'phrase_set_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + assert "phraseSetId" in jsonified_request + assert jsonified_request["phraseSetId"] == 'phrase_set_id_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "phraseSetId", "phraseSet", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_create_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_create_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.CreatePhraseSetRequest.pb(cloud_speech_adaptation.CreatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.CreatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.create_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_phrase_set(request) + + +def test_create_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_create_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +def test_create_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_get_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.GetPhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_get_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_get_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.GetPhraseSetRequest.pb(cloud_speech_adaptation.GetPhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.GetPhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.get_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_phrase_set(request) + + +def test_get_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_get_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +def test_get_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListPhraseSetRequest, + dict, +]) +def test_list_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.ListPhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_list_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_list_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.ListPhraseSetRequest.pb(cloud_speech_adaptation.ListPhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech_adaptation.ListPhraseSetResponse.to_json(cloud_speech_adaptation.ListPhraseSetResponse()) + + request = cloud_speech_adaptation.ListPhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + client.list_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_phrase_set(request) + + +def test_list_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListPhraseSetResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_list_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +def test_list_phrase_set_rest_pager(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech_adaptation.ListPhraseSetResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_phrase_set(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in results) + + pages = list(client.list_phrase_set(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request_init["phrase_set"] = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech_adaptation.UpdatePhraseSetRequest.meta.fields["phrase_set"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["phrase_set"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["phrase_set"][field])): + del request_init["phrase_set"][field][i][subfield] + else: + del request_init["phrase_set"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_update_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("phraseSet", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_update_phrase_set") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_update_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.UpdatePhraseSetRequest.pb(cloud_speech_adaptation.UpdatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.PhraseSet.to_json(resource.PhraseSet()) + + request = cloud_speech_adaptation.UpdatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.PhraseSet() + + client.update_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_phrase_set(request) + + +def test_update_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_update_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_phrase_set_rest_required_fields(request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_phrase_set_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_phrase_set_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_delete_phrase_set") as pre: + pre.assert_not_called() + pb_message = cloud_speech_adaptation.DeletePhraseSetRequest.pb(cloud_speech_adaptation.DeletePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = cloud_speech_adaptation.DeletePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_phrase_set(request) + + +def test_delete_phrase_set_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_delete_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +def test_delete_phrase_set_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.CreateCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["custom_class_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + jsonified_request["customClassId"] = 'custom_class_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + assert "customClassId" in jsonified_request + assert jsonified_request["customClassId"] == 'custom_class_id_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "customClassId", "customClass", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_create_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_create_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.CreateCustomClassRequest.pb(cloud_speech_adaptation.CreateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.CreateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.create_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_custom_class(request) + + +def test_create_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_create_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +def test_create_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.GetCustomClassRequest, + dict, +]) +def test_get_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_get_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.GetCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_get_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_get_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.GetCustomClassRequest.pb(cloud_speech_adaptation.GetCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.GetCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.get_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_custom_class(request) + + +def test_get_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_get_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +def test_get_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_custom_classes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_rest_required_fields(request_type=cloud_speech_adaptation.ListCustomClassesRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_custom_classes(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_custom_classes_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_custom_classes._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_custom_classes_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_list_custom_classes") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_list_custom_classes") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.ListCustomClassesRequest.pb(cloud_speech_adaptation.ListCustomClassesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech_adaptation.ListCustomClassesResponse.to_json(cloud_speech_adaptation.ListCustomClassesResponse()) + + request = cloud_speech_adaptation.ListCustomClassesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + client.list_custom_classes(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_custom_classes_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_custom_classes(request) + + +def test_list_custom_classes_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech_adaptation.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_custom_classes(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_list_custom_classes_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_rest_pager(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech_adaptation.ListCustomClassesResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_custom_classes(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in results) + + pages = list(client.list_custom_classes(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request_init["custom_class"] = {'name': 'projects/sample1/locations/sample2/customClasses/sample3', 'custom_class_id': 'custom_class_id_value', 'items': [{'value': 'value_value'}]} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech_adaptation.UpdateCustomClassRequest.meta.fields["custom_class"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["custom_class"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["custom_class"][field])): + del request_init["custom_class"][field][i][subfield] + else: + del request_init["custom_class"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_update_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("customClass", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "post_update_custom_class") as post, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_update_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech_adaptation.UpdateCustomClassRequest.pb(cloud_speech_adaptation.UpdateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = resource.CustomClass.to_json(resource.CustomClass()) + + request = cloud_speech_adaptation.UpdateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resource.CustomClass() + + client.update_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_custom_class(request) + + +def test_update_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = resource.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resource.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{custom_class.name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_update_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech_adaptation.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_custom_class(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_custom_class_rest_required_fields(request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + transport_class = transports.AdaptationRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_custom_class_rest_unset_required_fields(): + transport = transports.AdaptationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_custom_class_rest_interceptors(null_interceptor): + transport = transports.AdaptationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AdaptationRestInterceptor(), + ) + client = AdaptationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AdaptationRestInterceptor, "pre_delete_custom_class") as pre: + pre.assert_not_called() + pb_message = cloud_speech_adaptation.DeleteCustomClassRequest.pb(cloud_speech_adaptation.DeleteCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = cloud_speech_adaptation.DeleteCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_custom_class(request) + + +def test_delete_custom_class_rest_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_delete_custom_class_rest_flattened_error(transport: str = 'rest'): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +def test_delete_custom_class_rest_error(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AdaptationClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AdaptationClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AdaptationClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AdaptationGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + transports.AdaptationRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = AdaptationClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AdaptationGrpcTransport, + ) + +def test_adaptation_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_adaptation_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_phrase_set', + 'get_phrase_set', + 'list_phrase_set', + 'update_phrase_set', + 'delete_phrase_set', + 'create_custom_class', + 'get_custom_class', + 'list_custom_classes', + 'update_custom_class', + 'delete_custom_class', + 'get_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport() + adc.assert_called_once() + + +def test_adaptation_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) + AdaptationClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + ], +) +def test_adaptation_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.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + transports.AdaptationRestTransport, + ], +) +def test_adaptation_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AdaptationGrpcTransport, grpc_helpers), + (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_adaptation_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( + "speech.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="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_adaptation_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.AdaptationRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_adaptation_host_no_port(transport_name): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_adaptation_host_with_port(transport_name): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_adaptation_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = AdaptationClient( + credentials=creds1, + transport=transport_name, + ) + client2 = AdaptationClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_phrase_set._session + session2 = client2.transport.create_phrase_set._session + assert session1 != session2 + session1 = client1.transport.get_phrase_set._session + session2 = client2.transport.get_phrase_set._session + assert session1 != session2 + session1 = client1.transport.list_phrase_set._session + session2 = client2.transport.list_phrase_set._session + assert session1 != session2 + session1 = client1.transport.update_phrase_set._session + session2 = client2.transport.update_phrase_set._session + assert session1 != session2 + session1 = client1.transport.delete_phrase_set._session + session2 = client2.transport.delete_phrase_set._session + assert session1 != session2 + session1 = client1.transport.create_custom_class._session + session2 = client2.transport.create_custom_class._session + assert session1 != session2 + session1 = client1.transport.get_custom_class._session + session2 = client2.transport.get_custom_class._session + assert session1 != session2 + session1 = client1.transport.list_custom_classes._session + session2 = client2.transport.list_custom_classes._session + assert session1 != session2 + session1 = client1.transport.update_custom_class._session + session2 = client2.transport.update_custom_class._session + assert session1 != session2 + session1 = client1.transport.delete_custom_class._session + session2 = client2.transport.delete_custom_class._session + assert session1 != session2 +def test_adaptation_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcTransport( + 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_adaptation_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcAsyncIOTransport( + 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = AdaptationClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = AdaptationClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = AdaptationClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = AdaptationClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = AdaptationClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = AdaptationClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = AdaptationClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = AdaptationClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = AdaptationClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = AdaptationClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = AdaptationClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = AdaptationClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.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 = AdaptationClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = AdaptationClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + transport_class = AdaptationClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_get_operation(transport: str = "grpc"): + client = AdaptationClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = AdaptationAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = AdaptationClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = AdaptationAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = AdaptationClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = AdaptationAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = AdaptationClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = AdaptationAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (AdaptationClient, transports.AdaptationGrpcTransport), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py new file mode 100644 index 00000000..2b652316 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py @@ -0,0 +1,2576 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1p1beta1.services.speech import SpeechAsyncClient +from google.cloud.speech_v1p1beta1.services.speech import SpeechClient +from google.cloud.speech_v1p1beta1.services.speech import transports +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.SpeechGrpcTransport, "grpc"), + (transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + transports.SpeechRestTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_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(SpeechClient, '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(SpeechClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (SpeechClient, transports.SpeechRestTransport, "rest", "true"), + (SpeechClient, transports.SpeechRestTransport, "rest", "false"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, SpeechAsyncClient +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (SpeechClient, transports.SpeechRestTransport, "rest", None), +]) +def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_speech_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_speech_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse( + request_id=1077, + ) + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +def test_recognize_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 = SpeechClient( + 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.recognize), + '__call__') as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + +@pytest.mark.asyncio +async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): + client = SpeechAsyncClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( + request_id=1077, + )) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + + +def test_recognize_flattened_error(): + client = SpeechClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.LongRunningRecognizeRequest, + dict, +]) +def test_long_running_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_long_running_recognize_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 = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + client.long_running_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + +@pytest.mark.asyncio +async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechAsyncClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_long_running_recognize_async_from_dict(): + await test_long_running_recognize_async(request_type=dict) + + +def test_long_running_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + + +def test_long_running_recognize_flattened_error(): + client = SpeechClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert arg == mock_val + arg = args[0].audio + mock_val = cloud_speech.RecognitionAudio(content=b'content_blob') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.StreamingRecognizeRequest, + dict, +]) +def test_streaming_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechAsyncClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse( + request_id=1077, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.recognize(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + assert response.request_id == 1077 + + +def test_recognize_rest_required_fields(request_type=cloud_speech.RecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("config", "audio", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.RecognizeRequest.pb(cloud_speech.RecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.RecognizeResponse.to_json(cloud_speech.RecognizeResponse()) + + request = cloud_speech.RecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.RecognizeResponse() + + client.recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.RecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.recognize(request) + + +def test_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/speech:recognize" % client.transport._host, args[1]) + + +def test_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.LongRunningRecognizeRequest, + dict, +]) +def test_long_running_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.long_running_recognize(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_long_running_recognize_rest_required_fields(request_type=cloud_speech.LongRunningRecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).long_running_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).long_running_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.long_running_recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_long_running_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.long_running_recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("config", "audio", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_long_running_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_long_running_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_long_running_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.LongRunningRecognizeRequest.pb(cloud_speech.LongRunningRecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.LongRunningRecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.long_running_recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_long_running_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.long_running_recognize(request) + + +def test_long_running_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.long_running_recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1p1beta1/speech:longrunningrecognize" % client.transport._host, args[1]) + + +def test_long_running_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_long_running_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_streaming_recognize_rest_no_http_options(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = cloud_speech.StreamingRecognizeRequest() + requests = [request] + with pytest.raises(RuntimeError): + client.streaming_recognize(requests) + + +def test_streaming_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + # Since a `google.api.http` annotation is required for using a rest transport + # method, this should error. + with pytest.raises(NotImplementedError) as not_implemented_error: + client.streaming_recognize({}) + assert ( + "Method StreamingRecognize is not available over REST transport" + in str(not_implemented_error.value) + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = SpeechClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'recognize', + 'long_running_recognize', + 'streaming_recognize', + 'get_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +def test_speech_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) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_speech_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.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, + ], +) +def test_speech_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_speech_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( + "speech.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="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_speech_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.SpeechRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_speech_rest_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_no_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_with_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_speech_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = SpeechClient( + credentials=creds1, + transport=transport_name, + ) + client2 = SpeechClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.recognize._session + session2 = client2.transport.recognize._session + assert session1 != session2 + session1 = client1.transport.long_running_recognize._session + session2 = client2.transport.long_running_recognize._session + assert session1 != session2 + session1 = client1.transport.streaming_recognize._session + session2 = client2.transport.streaming_recognize._session + assert session1 != session2 +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + 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_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_speech_grpc_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = SpeechClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = SpeechClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = SpeechClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = SpeechClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.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 = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_get_operation(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (SpeechClient, transports.SpeechGrpcTransport), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc new file mode 100644 index 00000000..2a1c2d22 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/speech/__init__.py + google/cloud/speech/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 00000000..29227d4c --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v2/MANIFEST.in b/owl-bot-staging/v2/MANIFEST.in new file mode 100644 index 00000000..dd2a822c --- /dev/null +++ b/owl-bot-staging/v2/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/speech *.py +recursive-include google/cloud/speech_v2 *.py diff --git a/owl-bot-staging/v2/README.rst b/owl-bot-staging/v2/README.rst new file mode 100644 index 00000000..36384b14 --- /dev/null +++ b/owl-bot-staging/v2/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Speech 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 Speech 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/v2/docs/_static/custom.css b/owl-bot-staging/v2/docs/_static/custom.css new file mode 100644 index 00000000..06423be0 --- /dev/null +++ b/owl-bot-staging/v2/docs/_static/custom.css @@ -0,0 +1,3 @@ +dl.field-list > dt { + min-width: 100px +} diff --git a/owl-bot-staging/v2/docs/conf.py b/owl-bot-staging/v2/docs/conf.py new file mode 100644 index 00000000..3f5925bc --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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-speech documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-speech" +copyright = u"2023, 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 = 'en' + +# 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-speech-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-speech.tex", + u"google-cloud-speech Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-speech", + u"Google Cloud Speech Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-speech", + u"google-cloud-speech Documentation", + author, + "google-cloud-speech", + "GAPIC library for Google Cloud Speech 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/v2/docs/index.rst b/owl-bot-staging/v2/docs/index.rst new file mode 100644 index 00000000..cf0c808d --- /dev/null +++ b/owl-bot-staging/v2/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + speech_v2/services + speech_v2/types diff --git a/owl-bot-staging/v2/docs/speech_v2/services_.rst b/owl-bot-staging/v2/docs/speech_v2/services_.rst new file mode 100644 index 00000000..b74a632d --- /dev/null +++ b/owl-bot-staging/v2/docs/speech_v2/services_.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Speech v2 API +======================================= +.. toctree:: + :maxdepth: 2 + + speech diff --git a/owl-bot-staging/v2/docs/speech_v2/speech.rst b/owl-bot-staging/v2/docs/speech_v2/speech.rst new file mode 100644 index 00000000..54fe79f4 --- /dev/null +++ b/owl-bot-staging/v2/docs/speech_v2/speech.rst @@ -0,0 +1,10 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v2.services.speech + :members: + :inherited-members: + +.. automodule:: google.cloud.speech_v2.services.speech.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v2/docs/speech_v2/types_.rst b/owl-bot-staging/v2/docs/speech_v2/types_.rst new file mode 100644 index 00000000..50b05601 --- /dev/null +++ b/owl-bot-staging/v2/docs/speech_v2/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Speech v2 API +==================================== + +.. automodule:: google.cloud.speech_v2.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v2/google/cloud/speech/__init__.py b/owl-bot-staging/v2/google/cloud/speech/__init__.py new file mode 100644 index 00000000..02026664 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech/__init__.py @@ -0,0 +1,143 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.speech_v2.services.speech.client import SpeechClient +from google.cloud.speech_v2.services.speech.async_client import SpeechAsyncClient + +from google.cloud.speech_v2.types.cloud_speech import AutoDetectDecodingConfig +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeFileMetadata +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeFileResult +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeMetadata +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeRequest +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeResponse +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeResults +from google.cloud.speech_v2.types.cloud_speech import BatchRecognizeTranscriptionMetadata +from google.cloud.speech_v2.types.cloud_speech import CloudStorageResult +from google.cloud.speech_v2.types.cloud_speech import Config +from google.cloud.speech_v2.types.cloud_speech import CreateCustomClassRequest +from google.cloud.speech_v2.types.cloud_speech import CreatePhraseSetRequest +from google.cloud.speech_v2.types.cloud_speech import CreateRecognizerRequest +from google.cloud.speech_v2.types.cloud_speech import CustomClass +from google.cloud.speech_v2.types.cloud_speech import DeleteCustomClassRequest +from google.cloud.speech_v2.types.cloud_speech import DeletePhraseSetRequest +from google.cloud.speech_v2.types.cloud_speech import DeleteRecognizerRequest +from google.cloud.speech_v2.types.cloud_speech import ExplicitDecodingConfig +from google.cloud.speech_v2.types.cloud_speech import GcsOutputConfig +from google.cloud.speech_v2.types.cloud_speech import GetConfigRequest +from google.cloud.speech_v2.types.cloud_speech import GetCustomClassRequest +from google.cloud.speech_v2.types.cloud_speech import GetPhraseSetRequest +from google.cloud.speech_v2.types.cloud_speech import GetRecognizerRequest +from google.cloud.speech_v2.types.cloud_speech import InlineOutputConfig +from google.cloud.speech_v2.types.cloud_speech import InlineResult +from google.cloud.speech_v2.types.cloud_speech import ListCustomClassesRequest +from google.cloud.speech_v2.types.cloud_speech import ListCustomClassesResponse +from google.cloud.speech_v2.types.cloud_speech import ListPhraseSetsRequest +from google.cloud.speech_v2.types.cloud_speech import ListPhraseSetsResponse +from google.cloud.speech_v2.types.cloud_speech import ListRecognizersRequest +from google.cloud.speech_v2.types.cloud_speech import ListRecognizersResponse +from google.cloud.speech_v2.types.cloud_speech import OperationMetadata +from google.cloud.speech_v2.types.cloud_speech import PhraseSet +from google.cloud.speech_v2.types.cloud_speech import RecognitionConfig +from google.cloud.speech_v2.types.cloud_speech import RecognitionFeatures +from google.cloud.speech_v2.types.cloud_speech import RecognitionOutputConfig +from google.cloud.speech_v2.types.cloud_speech import RecognitionResponseMetadata +from google.cloud.speech_v2.types.cloud_speech import Recognizer +from google.cloud.speech_v2.types.cloud_speech import RecognizeRequest +from google.cloud.speech_v2.types.cloud_speech import RecognizeResponse +from google.cloud.speech_v2.types.cloud_speech import SpeakerDiarizationConfig +from google.cloud.speech_v2.types.cloud_speech import SpeechAdaptation +from google.cloud.speech_v2.types.cloud_speech import SpeechRecognitionAlternative +from google.cloud.speech_v2.types.cloud_speech import SpeechRecognitionResult +from google.cloud.speech_v2.types.cloud_speech import StreamingRecognitionConfig +from google.cloud.speech_v2.types.cloud_speech import StreamingRecognitionFeatures +from google.cloud.speech_v2.types.cloud_speech import StreamingRecognitionResult +from google.cloud.speech_v2.types.cloud_speech import StreamingRecognizeRequest +from google.cloud.speech_v2.types.cloud_speech import StreamingRecognizeResponse +from google.cloud.speech_v2.types.cloud_speech import TranscriptNormalization +from google.cloud.speech_v2.types.cloud_speech import UndeleteCustomClassRequest +from google.cloud.speech_v2.types.cloud_speech import UndeletePhraseSetRequest +from google.cloud.speech_v2.types.cloud_speech import UndeleteRecognizerRequest +from google.cloud.speech_v2.types.cloud_speech import UpdateConfigRequest +from google.cloud.speech_v2.types.cloud_speech import UpdateCustomClassRequest +from google.cloud.speech_v2.types.cloud_speech import UpdatePhraseSetRequest +from google.cloud.speech_v2.types.cloud_speech import UpdateRecognizerRequest +from google.cloud.speech_v2.types.cloud_speech import WordInfo + +__all__ = ('SpeechClient', + 'SpeechAsyncClient', + 'AutoDetectDecodingConfig', + 'BatchRecognizeFileMetadata', + 'BatchRecognizeFileResult', + 'BatchRecognizeMetadata', + 'BatchRecognizeRequest', + 'BatchRecognizeResponse', + 'BatchRecognizeResults', + 'BatchRecognizeTranscriptionMetadata', + 'CloudStorageResult', + 'Config', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'CreateRecognizerRequest', + 'CustomClass', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'DeleteRecognizerRequest', + 'ExplicitDecodingConfig', + 'GcsOutputConfig', + 'GetConfigRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'GetRecognizerRequest', + 'InlineOutputConfig', + 'InlineResult', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetsRequest', + 'ListPhraseSetsResponse', + 'ListRecognizersRequest', + 'ListRecognizersResponse', + 'OperationMetadata', + 'PhraseSet', + 'RecognitionConfig', + 'RecognitionFeatures', + 'RecognitionOutputConfig', + 'RecognitionResponseMetadata', + 'Recognizer', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptation', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionFeatures', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptNormalization', + 'UndeleteCustomClassRequest', + 'UndeletePhraseSetRequest', + 'UndeleteRecognizerRequest', + 'UpdateConfigRequest', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'UpdateRecognizerRequest', + 'WordInfo', +) diff --git a/owl-bot-staging/v2/google/cloud/speech/gapic_version.py b/owl-bot-staging/v2/google/cloud/speech/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2/google/cloud/speech/py.typed b/owl-bot-staging/v2/google/cloud/speech/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/__init__.py b/owl-bot-staging/v2/google/cloud/speech_v2/__init__.py new file mode 100644 index 00000000..fd9f4f35 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/__init__.py @@ -0,0 +1,144 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.speech_v2 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import AutoDetectDecodingConfig +from .types.cloud_speech import BatchRecognizeFileMetadata +from .types.cloud_speech import BatchRecognizeFileResult +from .types.cloud_speech import BatchRecognizeMetadata +from .types.cloud_speech import BatchRecognizeRequest +from .types.cloud_speech import BatchRecognizeResponse +from .types.cloud_speech import BatchRecognizeResults +from .types.cloud_speech import BatchRecognizeTranscriptionMetadata +from .types.cloud_speech import CloudStorageResult +from .types.cloud_speech import Config +from .types.cloud_speech import CreateCustomClassRequest +from .types.cloud_speech import CreatePhraseSetRequest +from .types.cloud_speech import CreateRecognizerRequest +from .types.cloud_speech import CustomClass +from .types.cloud_speech import DeleteCustomClassRequest +from .types.cloud_speech import DeletePhraseSetRequest +from .types.cloud_speech import DeleteRecognizerRequest +from .types.cloud_speech import ExplicitDecodingConfig +from .types.cloud_speech import GcsOutputConfig +from .types.cloud_speech import GetConfigRequest +from .types.cloud_speech import GetCustomClassRequest +from .types.cloud_speech import GetPhraseSetRequest +from .types.cloud_speech import GetRecognizerRequest +from .types.cloud_speech import InlineOutputConfig +from .types.cloud_speech import InlineResult +from .types.cloud_speech import ListCustomClassesRequest +from .types.cloud_speech import ListCustomClassesResponse +from .types.cloud_speech import ListPhraseSetsRequest +from .types.cloud_speech import ListPhraseSetsResponse +from .types.cloud_speech import ListRecognizersRequest +from .types.cloud_speech import ListRecognizersResponse +from .types.cloud_speech import OperationMetadata +from .types.cloud_speech import PhraseSet +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionFeatures +from .types.cloud_speech import RecognitionOutputConfig +from .types.cloud_speech import RecognitionResponseMetadata +from .types.cloud_speech import Recognizer +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechAdaptation +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionFeatures +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import TranscriptNormalization +from .types.cloud_speech import UndeleteCustomClassRequest +from .types.cloud_speech import UndeletePhraseSetRequest +from .types.cloud_speech import UndeleteRecognizerRequest +from .types.cloud_speech import UpdateConfigRequest +from .types.cloud_speech import UpdateCustomClassRequest +from .types.cloud_speech import UpdatePhraseSetRequest +from .types.cloud_speech import UpdateRecognizerRequest +from .types.cloud_speech import WordInfo + +__all__ = ( + 'SpeechAsyncClient', +'AutoDetectDecodingConfig', +'BatchRecognizeFileMetadata', +'BatchRecognizeFileResult', +'BatchRecognizeMetadata', +'BatchRecognizeRequest', +'BatchRecognizeResponse', +'BatchRecognizeResults', +'BatchRecognizeTranscriptionMetadata', +'CloudStorageResult', +'Config', +'CreateCustomClassRequest', +'CreatePhraseSetRequest', +'CreateRecognizerRequest', +'CustomClass', +'DeleteCustomClassRequest', +'DeletePhraseSetRequest', +'DeleteRecognizerRequest', +'ExplicitDecodingConfig', +'GcsOutputConfig', +'GetConfigRequest', +'GetCustomClassRequest', +'GetPhraseSetRequest', +'GetRecognizerRequest', +'InlineOutputConfig', +'InlineResult', +'ListCustomClassesRequest', +'ListCustomClassesResponse', +'ListPhraseSetsRequest', +'ListPhraseSetsResponse', +'ListRecognizersRequest', +'ListRecognizersResponse', +'OperationMetadata', +'PhraseSet', +'RecognitionConfig', +'RecognitionFeatures', +'RecognitionOutputConfig', +'RecognitionResponseMetadata', +'RecognizeRequest', +'RecognizeResponse', +'Recognizer', +'SpeakerDiarizationConfig', +'SpeechAdaptation', +'SpeechClient', +'SpeechRecognitionAlternative', +'SpeechRecognitionResult', +'StreamingRecognitionConfig', +'StreamingRecognitionFeatures', +'StreamingRecognitionResult', +'StreamingRecognizeRequest', +'StreamingRecognizeResponse', +'TranscriptNormalization', +'UndeleteCustomClassRequest', +'UndeletePhraseSetRequest', +'UndeleteRecognizerRequest', +'UpdateConfigRequest', +'UpdateCustomClassRequest', +'UpdatePhraseSetRequest', +'UpdateRecognizerRequest', +'WordInfo', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/gapic_metadata.json b/owl-bot-staging/v2/google/cloud/speech_v2/gapic_metadata.json new file mode 100644 index 00000000..d835882c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/gapic_metadata.json @@ -0,0 +1,373 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v2", + "protoPackage": "google.cloud.speech.v2", + "schema": "1.0", + "services": { + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "BatchRecognize": { + "methods": [ + "batch_recognize" + ] + }, + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "CreateRecognizer": { + "methods": [ + "create_recognizer" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "DeleteRecognizer": { + "methods": [ + "delete_recognizer" + ] + }, + "GetConfig": { + "methods": [ + "get_config" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "GetRecognizer": { + "methods": [ + "get_recognizer" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSets": { + "methods": [ + "list_phrase_sets" + ] + }, + "ListRecognizers": { + "methods": [ + "list_recognizers" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + }, + "UndeleteCustomClass": { + "methods": [ + "undelete_custom_class" + ] + }, + "UndeletePhraseSet": { + "methods": [ + "undelete_phrase_set" + ] + }, + "UndeleteRecognizer": { + "methods": [ + "undelete_recognizer" + ] + }, + "UpdateConfig": { + "methods": [ + "update_config" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + }, + "UpdateRecognizer": { + "methods": [ + "update_recognizer" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "BatchRecognize": { + "methods": [ + "batch_recognize" + ] + }, + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "CreateRecognizer": { + "methods": [ + "create_recognizer" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "DeleteRecognizer": { + "methods": [ + "delete_recognizer" + ] + }, + "GetConfig": { + "methods": [ + "get_config" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "GetRecognizer": { + "methods": [ + "get_recognizer" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSets": { + "methods": [ + "list_phrase_sets" + ] + }, + "ListRecognizers": { + "methods": [ + "list_recognizers" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + }, + "UndeleteCustomClass": { + "methods": [ + "undelete_custom_class" + ] + }, + "UndeletePhraseSet": { + "methods": [ + "undelete_phrase_set" + ] + }, + "UndeleteRecognizer": { + "methods": [ + "undelete_recognizer" + ] + }, + "UpdateConfig": { + "methods": [ + "update_config" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + }, + "UpdateRecognizer": { + "methods": [ + "update_recognizer" + ] + } + } + }, + "rest": { + "libraryClient": "SpeechClient", + "rpcs": { + "BatchRecognize": { + "methods": [ + "batch_recognize" + ] + }, + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "CreateRecognizer": { + "methods": [ + "create_recognizer" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "DeleteRecognizer": { + "methods": [ + "delete_recognizer" + ] + }, + "GetConfig": { + "methods": [ + "get_config" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "GetRecognizer": { + "methods": [ + "get_recognizer" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSets": { + "methods": [ + "list_phrase_sets" + ] + }, + "ListRecognizers": { + "methods": [ + "list_recognizers" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + }, + "UndeleteCustomClass": { + "methods": [ + "undelete_custom_class" + ] + }, + "UndeletePhraseSet": { + "methods": [ + "undelete_phrase_set" + ] + }, + "UndeleteRecognizer": { + "methods": [ + "undelete_recognizer" + ] + }, + "UpdateConfig": { + "methods": [ + "update_config" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + }, + "UpdateRecognizer": { + "methods": [ + "update_recognizer" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/gapic_version.py b/owl-bot-staging/v2/google/cloud/speech_v2/gapic_version.py new file mode 100644 index 00000000..360a0d13 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/py.typed b/owl-bot-staging/v2/google/cloud/speech_v2/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/__init__.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/__init__.py new file mode 100644 index 00000000..89a37dc9 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v2/google/cloud/speech_v2/services/speech/__init__.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/__init__.py new file mode 100644 index 00000000..0b9e4f6e --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + 'SpeechClient', + 'SpeechAsyncClient', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/async_client.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/async_client.py new file mode 100644 index 00000000..c9368cae --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/async_client.py @@ -0,0 +1,3446 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union + +from google.cloud.speech_v2 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Enables speech transcription and resource management.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + config_path = staticmethod(SpeechClient.config_path) + parse_config_path = staticmethod(SpeechClient.parse_config_path) + crypto_key_path = staticmethod(SpeechClient.crypto_key_path) + parse_crypto_key_path = staticmethod(SpeechClient.parse_crypto_key_path) + crypto_key_version_path = staticmethod(SpeechClient.crypto_key_version_path) + parse_crypto_key_version_path = staticmethod(SpeechClient.parse_crypto_key_version_path) + custom_class_path = staticmethod(SpeechClient.custom_class_path) + parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) + phrase_set_path = staticmethod(SpeechClient.phrase_set_path) + parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) + recognizer_path = staticmethod(SpeechClient.recognizer_path) + parse_recognizer_path = staticmethod(SpeechClient.parse_recognizer_path) + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return SpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_recognizer(self, + request: Optional[Union[cloud_speech.CreateRecognizerRequest, dict]] = None, + *, + parent: Optional[str] = None, + recognizer: Optional[cloud_speech.Recognizer] = None, + recognizer_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_create_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreateRecognizerRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.CreateRecognizerRequest, dict]]): + The request object. Request message for the + [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] + method. + parent (:class:`str`): + Required. The project and location where this Recognizer + will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + recognizer (:class:`google.cloud.speech_v2.types.Recognizer`): + Required. The Recognizer to create. + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + recognizer_id (:class:`str`): + The ID to use for the Recognizer, which will become the + final component of the Recognizer's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``recognizer_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, recognizer, recognizer_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.CreateRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if recognizer is not None: + request.recognizer = recognizer + if recognizer_id is not None: + request.recognizer_id = recognizer_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_recognizer, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_recognizers(self, + request: Optional[Union[cloud_speech.ListRecognizersRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecognizersAsyncPager: + r"""Lists Recognizers. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_list_recognizers(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListRecognizersRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_recognizers(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.ListRecognizersRequest, dict]]): + The request object. Request message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + parent (:class:`str`): + Required. The project and location of Recognizers to + list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager: + Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.ListRecognizersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_recognizers, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRecognizersAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_recognizer(self, + request: Optional[Union[cloud_speech.GetRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Recognizer: + r"""Returns the requested + [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with + [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested + Recognizer doesn't exist. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_get_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetRecognizerRequest( + name="name_value", + ) + + # Make the request + response = await client.get_recognizer(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.GetRecognizerRequest, dict]]): + The request object. Request message for the + [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] + method. + name (:class:`str`): + Required. The name of the Recognizer to retrieve. The + expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + + 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.speech_v2.types.Recognizer: + A Recognizer message. Stores + recognition configuration and metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.GetRecognizerRequest(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_recognizer, + 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_recognizer(self, + request: Optional[Union[cloud_speech.UpdateRecognizerRequest, dict]] = None, + *, + recognizer: Optional[cloud_speech.Recognizer] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_update_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateRecognizerRequest( + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UpdateRecognizerRequest, dict]]): + The request object. Request message for the + [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] + method. + recognizer (:class:`google.cloud.speech_v2.types.Recognizer`): + Required. The Recognizer to update. + + The Recognizer's ``name`` field is used to identify the + Recognizer to update. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + + This corresponds to the ``recognizer`` 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 update. If empty, all non-default + valued fields are considered for update. Use ``*`` to + update the entire Recognizer resource. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, 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 = cloud_speech.UpdateRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + 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_recognizer, + 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(( + ("recognizer.name", request.recognizer.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_recognizer(self, + request: Optional[Union[cloud_speech.DeleteRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_delete_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.DeleteRecognizerRequest, dict]]): + The request object. Request message for the + [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] + method. + name (:class:`str`): + Required. The name of the Recognizer to delete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.DeleteRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_recognizer, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_recognizer(self, + request: Optional[Union[cloud_speech.UndeleteRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_undelete_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UndeleteRecognizerRequest, dict]]): + The request object. Request message for the + [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] + method. + name (:class:`str`): + Required. The name of the Recognizer to undelete. + Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.UndeleteRecognizerRequest(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.undelete_recognizer, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + recognizer: Optional[str] = None, + config: Optional[cloud_speech.RecognitionConfig] = None, + config_mask: Optional[field_mask_pb2.FieldMask] = None, + content: Optional[bytes] = None, + uri: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.RecognizeRequest( + content=b'content_blob', + recognizer="recognizer_value", + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.RecognizeRequest, dict]]): + The request object. Request message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. Either ``content`` or ``uri`` must be supplied. + Supplying both or neither returns + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + recognizer (:class:`str`): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an + empty implicit Recognizer. + + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config (:class:`google.cloud.speech_v2.types.RecognitionConfig`): + Features and audio metadata to use for the Automatic + Speech Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + The list of fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all non-default valued fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + override the values in the recognizer for this + recognition request. If a mask is provided, only the + fields listed in the mask override the config in the + recognizer for this recognition request. If a wildcard + (``*``) is provided, + [config][google.cloud.speech.v2.RecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + + This corresponds to the ``config_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + content (:class:`bytes`): + The audio data bytes encoded as specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + As with all bytes fields, proto buffers use a pure + binary representation, whereas JSON representations use + base64. + + This corresponds to the ``content`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + uri (:class:`str`): + URI that points to a file that contains audio data bytes + as specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + The file must not be compressed (for example, gzip). + Currently, only Google Cloud Storage URIs are supported, + which must be specified in the following format: + ``gs://bucket_name/object_name`` (other URI formats + return + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + + This corresponds to the ``uri`` 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.speech_v2.types.RecognizeResponse: + Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, content, uri]) + 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 = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if content is not None: + request.content = content + if uri is not None: + request.uri = uri + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + 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(( + ("recognizer", request.recognizer), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[AsyncIterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_streaming_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.StreamingRecognizeRequest( + recognizer="recognizer_value", + ) + + # This method expects an iterator which contains + # 'speech_v2.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + + Args: + requests (AsyncIterator[`google.cloud.speech_v2.types.StreamingRecognizeRequest`]): + The request object AsyncIterator. Request message for the + [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] + method. Multiple + [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] + messages are sent in one call. + + If the [Recognizer][google.cloud.speech.v2.Recognizer] + referenced by + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + contains a fully specified request configuration then + the stream may only contain messages with only + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + set. + + Otherwise the first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message that together fully specify the request + configuration and must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. + All subsequent messages must only have + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + 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: + AsyncIterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio then + no messages are streamed back to the client. + + Here are some examples of StreamingRecognizeResponses + that might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def batch_recognize(self, + request: Optional[Union[cloud_speech.BatchRecognizeRequest, dict]] = None, + *, + recognizer: Optional[str] = None, + config: Optional[cloud_speech.RecognitionConfig] = None, + config_mask: Optional[field_mask_pb2.FieldMask] = None, + files: Optional[MutableSequence[cloud_speech.BatchRecognizeFileMetadata]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Performs batch asynchronous speech recognition: send + a request with N audio files and receive a long running + operation that can be polled to see when the + transcriptions are finished. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_batch_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.BatchRecognizeRequest( + recognizer="recognizer_value", + ) + + # Make the request + operation = client.batch_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.BatchRecognizeRequest, dict]]): + The request object. Request message for the + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + method. + recognizer (:class:`str`): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an + empty implicit Recognizer. + + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config (:class:`google.cloud.speech_v2.types.RecognitionConfig`): + Features and audio metadata to use for the Automatic + Speech Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + The list of fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all given fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + override the values in the recognizer for this + recognition request. If a mask is provided, only the + fields listed in the mask override the config in the + recognizer for this recognition request. If a wildcard + (``*``) is provided, + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + + This corresponds to the ``config_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + files (:class:`MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]`): + Audio files with file metadata for + ASR. The maximum number of files allowed + to be specified is 5. + + This corresponds to the ``files`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.BatchRecognizeResponse` Response message for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + that is packaged into a longrunning + [Operation][google.longrunning.Operation]. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, files]) + 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 = cloud_speech.BatchRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if files: + request.files.extend(files) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.batch_recognize, + 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(( + ("recognizer", request.recognizer), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.BatchRecognizeResponse, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def get_config(self, + request: Optional[Union[cloud_speech.GetConfigRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Returns the requested [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_get_config(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetConfigRequest( + name="name_value", + ) + + # Make the request + response = await client.get_config(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.GetConfigRequest, dict]]): + The request object. Request message for the + [GetConfig][google.cloud.speech.v2.Speech.GetConfig] + method. + name (:class:`str`): + Required. The name of the config to retrieve. There is + exactly one config resource per project per location. + The expected format is + ``projects/{project}/locations/{location}/config``. + + 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.speech_v2.types.Config: + Message representing the config for the Speech-to-Text API. This includes an + optional [KMS + key](\ https://cloud.google.com/kms/docs/resource-hierarchy#keys) + with which incoming data will be encrypted. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.GetConfigRequest(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_config, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_config(self, + request: Optional[Union[cloud_speech.UpdateConfigRequest, dict]] = None, + *, + config: Optional[cloud_speech.Config] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Updates the [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_update_config(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateConfigRequest( + ) + + # Make the request + response = await client.update_config(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UpdateConfigRequest, dict]]): + The request object. Request message for the + [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] + method. + config (:class:`google.cloud.speech_v2.types.Config`): + Required. The config to update. + + The config's ``name`` field is used to identify the + config to be updated. The expected format is + ``projects/{project}/locations/{location}/config``. + + This corresponds to the ``config`` 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.speech_v2.types.Config: + Message representing the config for the Speech-to-Text API. This includes an + optional [KMS + key](\ https://cloud.google.com/kms/docs/resource-hierarchy#keys) + with which incoming data will be encrypted. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.UpdateConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_config, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("config.name", request.config.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_custom_class(self, + request: Optional[Union[cloud_speech.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[cloud_speech.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_create_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreateCustomClassRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.CreateCustomClassRequest, dict]]): + The request object. Request message for the + [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] + method. + parent (:class:`str`): + Required. The project and location where this + CustomClass will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (:class:`google.cloud.speech_v2.types.CustomClass`): + Required. The CustomClass to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (:class:`str`): + The ID to use for the CustomClass, which will become the + final component of the CustomClass's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.CreateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_custom_class, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_custom_classes(self, + request: Optional[Union[cloud_speech.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesAsyncPager: + r"""Lists CustomClasses. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_list_custom_classes(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.ListCustomClassesRequest, dict]]): + The request object. Request message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + parent (:class:`str`): + Required. The project and location of CustomClass + resources to list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager: + Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.ListCustomClassesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_custom_classes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListCustomClassesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_custom_class(self, + request: Optional[Union[cloud_speech.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.CustomClass: + r"""Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_get_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.GetCustomClassRequest, dict]]): + The request object. Request message for the + [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] + method. + name (:class:`str`): + Required. The name of the CustomClass to retrieve. The + expected format is + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + + 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.speech_v2.types.CustomClass: + CustomClass for biasing in speech + recognition. Used to define a set of + words or phrases that represents a + common concept or theme likely to appear + in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.GetCustomClassRequest(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_custom_class, + 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_custom_class(self, + request: Optional[Union[cloud_speech.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[cloud_speech.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_update_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateCustomClassRequest( + ) + + # Make the request + operation = client.update_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UpdateCustomClassRequest, dict]]): + The request object. Request message for the + [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] + method. + custom_class (:class:`google.cloud.speech_v2.types.CustomClass`): + Required. The CustomClass to update. + + The CustomClass's ``name`` field is used to identify the + CustomClass to update. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + + This corresponds to the ``custom_class`` 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. If + empty, all fields are considered for + update. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 = cloud_speech.UpdateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class, + 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(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_custom_class(self, + request: Optional[Union[cloud_speech.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_delete_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.DeleteCustomClassRequest, dict]]): + The request object. Request message for the + [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] + method. + name (:class:`str`): + Required. The name of the CustomClass to delete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.DeleteCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_custom_class, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_custom_class(self, + request: Optional[Union[cloud_speech.UndeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_undelete_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UndeleteCustomClassRequest, dict]]): + The request object. Request message for the + [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] + method. + name (:class:`str`): + Required. The name of the CustomClass to undelete. + Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.UndeleteCustomClassRequest(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.undelete_custom_class, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def create_phrase_set(self, + request: Optional[Union[cloud_speech.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[cloud_speech.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_create_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreatePhraseSetRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.CreatePhraseSetRequest, dict]]): + The request object. Request message for the + [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] + method. + parent (:class:`str`): + Required. The project and location where this PhraseSet + will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (:class:`google.cloud.speech_v2.types.PhraseSet`): + Required. The PhraseSet to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (:class:`str`): + The ID to use for the PhraseSet, which will become the + final component of the PhraseSet's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.CreatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_phrase_set, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_phrase_sets(self, + request: Optional[Union[cloud_speech.ListPhraseSetsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetsAsyncPager: + r"""Lists PhraseSets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_list_phrase_sets(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListPhraseSetsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_sets(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.ListPhraseSetsRequest, dict]]): + The request object. Request message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + parent (:class:`str`): + Required. The project and location of PhraseSet + resources to list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager: + Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.ListPhraseSetsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_phrase_sets, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListPhraseSetsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_phrase_set(self, + request: Optional[Union[cloud_speech.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.PhraseSet: + r"""Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_get_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.GetPhraseSetRequest, dict]]): + The request object. Request message for the + [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] + method. + name (:class:`str`): + Required. The name of the PhraseSet to retrieve. The + expected format is + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + + 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.speech_v2.types.PhraseSet: + PhraseSet for biasing in speech + recognition. A PhraseSet is used to + provide "hints" to the speech recognizer + to favor specific words and phrases in + the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.GetPhraseSetRequest(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_phrase_set, + 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_phrase_set(self, + request: Optional[Union[cloud_speech.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[cloud_speech.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_update_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdatePhraseSetRequest( + ) + + # Make the request + operation = client.update_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UpdatePhraseSetRequest, dict]]): + The request object. Request message for the + [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] + method. + phrase_set (:class:`google.cloud.speech_v2.types.PhraseSet`): + Required. The PhraseSet to update. + + The PhraseSet's ``name`` field is used to identify the + PhraseSet to update. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + + This corresponds to the ``phrase_set`` 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 update. If empty, all non-default + valued fields are considered for update. Use ``*`` to + update the entire PhraseSet resource. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 = cloud_speech.UpdatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set, + 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(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_phrase_set(self, + request: Optional[Union[cloud_speech.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_delete_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.DeletePhraseSetRequest, dict]]): + The request object. Request message for the + [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] + method. + name (:class:`str`): + Required. The name of the PhraseSet to delete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.DeletePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_phrase_set, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_phrase_set(self, + request: Optional[Union[cloud_speech.UndeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + async def sample_undelete_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.speech_v2.types.UndeletePhraseSetRequest, dict]]): + The request object. Request message for the + [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] + method. + name (:class:`str`): + Required. The name of the PhraseSet to undelete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_speech.UndeletePhraseSetRequest(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.undelete_phrase_set, + 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, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + 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 delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.delete_operation, + 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. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.cancel_operation, + 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. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_locations, + 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 __aenter__(self) -> "SpeechAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechAsyncClient", +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/client.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/client.py new file mode 100644 index 00000000..93398f7a --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/client.py @@ -0,0 +1,3686 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union, cast + +from google.cloud.speech_v2 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .transports.rest import SpeechRestTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech 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[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + _transport_registry["rest"] = SpeechRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[SpeechTransport]: + """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 SpeechClient(metaclass=SpeechClientMeta): + """Enables speech transcription and resource management.""" + + @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 = "speech.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: + SpeechClient: 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: + SpeechClient: 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) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def config_path(project: str,location: str,) -> str: + """Returns a fully-qualified config string.""" + return "projects/{project}/locations/{location}/config".format(project=project, location=location, ) + + @staticmethod + def parse_config_path(path: str) -> Dict[str,str]: + """Parses a config path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/config$", path) + return m.groupdict() if m else {} + + @staticmethod + def crypto_key_path(project: str,location: str,key_ring: str,crypto_key: str,) -> str: + """Returns a fully-qualified crypto_key string.""" + return "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}".format(project=project, location=location, key_ring=key_ring, crypto_key=crypto_key, ) + + @staticmethod + def parse_crypto_key_path(path: str) -> Dict[str,str]: + """Parses a crypto_key path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/keyRings/(?P.+?)/cryptoKeys/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def crypto_key_version_path(project: str,location: str,key_ring: str,crypto_key: str,crypto_key_version: str,) -> str: + """Returns a fully-qualified crypto_key_version string.""" + return "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}".format(project=project, location=location, key_ring=key_ring, crypto_key=crypto_key, crypto_key_version=crypto_key_version, ) + + @staticmethod + def parse_crypto_key_version_path(path: str) -> Dict[str,str]: + """Parses a crypto_key_version path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/keyRings/(?P.+?)/cryptoKeys/(?P.+?)/cryptoKeyVersions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def recognizer_path(project: str,location: str,recognizer: str,) -> str: + """Returns a fully-qualified recognizer string.""" + return "projects/{project}/locations/{location}/recognizers/{recognizer}".format(project=project, location=location, recognizer=recognizer, ) + + @staticmethod + def parse_recognizer_path(path: str) -> Dict[str,str]: + """Parses a recognizer path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recognizers/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, SpeechTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, SpeechTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def create_recognizer(self, + request: Optional[Union[cloud_speech.CreateRecognizerRequest, dict]] = None, + *, + parent: Optional[str] = None, + recognizer: Optional[cloud_speech.Recognizer] = None, + recognizer_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_create_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreateRecognizerRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.CreateRecognizerRequest, dict]): + The request object. Request message for the + [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] + method. + parent (str): + Required. The project and location where this Recognizer + will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + recognizer (google.cloud.speech_v2.types.Recognizer): + Required. The Recognizer to create. + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + recognizer_id (str): + The ID to use for the Recognizer, which will become the + final component of the Recognizer's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``recognizer_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, recognizer, recognizer_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreateRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreateRecognizerRequest): + request = cloud_speech.CreateRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if recognizer is not None: + request.recognizer = recognizer + if recognizer_id is not None: + request.recognizer_id = recognizer_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_recognizers(self, + request: Optional[Union[cloud_speech.ListRecognizersRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecognizersPager: + r"""Lists Recognizers. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_list_recognizers(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListRecognizersRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_recognizers(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.ListRecognizersRequest, dict]): + The request object. Request message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + parent (str): + Required. The project and location of Recognizers to + list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager: + Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListRecognizersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListRecognizersRequest): + request = cloud_speech.ListRecognizersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_recognizers] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRecognizersPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_recognizer(self, + request: Optional[Union[cloud_speech.GetRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Recognizer: + r"""Returns the requested + [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with + [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested + Recognizer doesn't exist. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_get_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetRecognizerRequest( + name="name_value", + ) + + # Make the request + response = client.get_recognizer(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.GetRecognizerRequest, dict]): + The request object. Request message for the + [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] + method. + name (str): + Required. The name of the Recognizer to retrieve. The + expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + + 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.speech_v2.types.Recognizer: + A Recognizer message. Stores + recognition configuration and metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetRecognizerRequest): + request = cloud_speech.GetRecognizerRequest(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_recognizer] + + # 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_recognizer(self, + request: Optional[Union[cloud_speech.UpdateRecognizerRequest, dict]] = None, + *, + recognizer: Optional[cloud_speech.Recognizer] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_update_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateRecognizerRequest( + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UpdateRecognizerRequest, dict]): + The request object. Request message for the + [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] + method. + recognizer (google.cloud.speech_v2.types.Recognizer): + Required. The Recognizer to update. + + The Recognizer's ``name`` field is used to identify the + Recognizer to update. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + + This corresponds to the ``recognizer`` 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 update. If empty, all non-default + valued fields are considered for update. Use ``*`` to + update the entire Recognizer resource. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, 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 cloud_speech.UpdateRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateRecognizerRequest): + request = cloud_speech.UpdateRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + 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_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("recognizer.name", request.recognizer.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_recognizer(self, + request: Optional[Union[cloud_speech.DeleteRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_delete_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.DeleteRecognizerRequest, dict]): + The request object. Request message for the + [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] + method. + name (str): + Required. The name of the Recognizer to delete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeleteRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeleteRecognizerRequest): + request = cloud_speech.DeleteRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_recognizer(self, + request: Optional[Union[cloud_speech.UndeleteRecognizerRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_undelete_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UndeleteRecognizerRequest, dict]): + The request object. Request message for the + [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] + method. + name (str): + Required. The name of the Recognizer to undelete. + Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeleteRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeleteRecognizerRequest): + request = cloud_speech.UndeleteRecognizerRequest(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.undelete_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def recognize(self, + request: Optional[Union[cloud_speech.RecognizeRequest, dict]] = None, + *, + recognizer: Optional[str] = None, + config: Optional[cloud_speech.RecognitionConfig] = None, + config_mask: Optional[field_mask_pb2.FieldMask] = None, + content: Optional[bytes] = None, + uri: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.RecognizeRequest( + content=b'content_blob', + recognizer="recognizer_value", + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.RecognizeRequest, dict]): + The request object. Request message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. Either ``content`` or ``uri`` must be supplied. + Supplying both or neither returns + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an + empty implicit Recognizer. + + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config (google.cloud.speech_v2.types.RecognitionConfig): + Features and audio metadata to use for the Automatic + Speech Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all non-default valued fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + override the values in the recognizer for this + recognition request. If a mask is provided, only the + fields listed in the mask override the config in the + recognizer for this recognition request. If a wildcard + (``*``) is provided, + [config][google.cloud.speech.v2.RecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + + This corresponds to the ``config_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + content (bytes): + The audio data bytes encoded as specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + As with all bytes fields, proto buffers use a pure + binary representation, whereas JSON representations use + base64. + + This corresponds to the ``content`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + uri (str): + URI that points to a file that contains audio data bytes + as specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + The file must not be compressed (for example, gzip). + Currently, only Google Cloud Storage URIs are supported, + which must be specified in the following format: + ``gs://bucket_name/object_name`` (other URI formats + return + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + + This corresponds to the ``uri`` 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.speech_v2.types.RecognizeResponse: + Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, content, uri]) + 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 cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if content is not None: + request.content = content + if uri is not None: + request.uri = uri + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("recognizer", request.recognizer), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Optional[Iterator[cloud_speech.StreamingRecognizeRequest]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_streaming_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.StreamingRecognizeRequest( + recognizer="recognizer_value", + ) + + # This method expects an iterator which contains + # 'speech_v2.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + + Args: + requests (Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]): + The request object iterator. Request message for the + [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] + method. Multiple + [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] + messages are sent in one call. + + If the [Recognizer][google.cloud.speech.v2.Recognizer] + referenced by + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + contains a fully specified request configuration then + the stream may only contain messages with only + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + set. + + Otherwise the first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message that together fully specify the request + configuration and must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. + All subsequent messages must only have + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + 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: + Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio then + no messages are streamed back to the client. + + Here are some examples of StreamingRecognizeResponses + that might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def batch_recognize(self, + request: Optional[Union[cloud_speech.BatchRecognizeRequest, dict]] = None, + *, + recognizer: Optional[str] = None, + config: Optional[cloud_speech.RecognitionConfig] = None, + config_mask: Optional[field_mask_pb2.FieldMask] = None, + files: Optional[MutableSequence[cloud_speech.BatchRecognizeFileMetadata]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Performs batch asynchronous speech recognition: send + a request with N audio files and receive a long running + operation that can be polled to see when the + transcriptions are finished. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_batch_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.BatchRecognizeRequest( + recognizer="recognizer_value", + ) + + # Make the request + operation = client.batch_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.BatchRecognizeRequest, dict]): + The request object. Request message for the + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + method. + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an + empty implicit Recognizer. + + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config (google.cloud.speech_v2.types.RecognitionConfig): + Features and audio metadata to use for the Automatic + Speech Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all given fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + override the values in the recognizer for this + recognition request. If a mask is provided, only the + fields listed in the mask override the config in the + recognizer for this recognition request. If a wildcard + (``*``) is provided, + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + + This corresponds to the ``config_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + files (MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]): + Audio files with file metadata for + ASR. The maximum number of files allowed + to be specified is 5. + + This corresponds to the ``files`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.BatchRecognizeResponse` Response message for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + that is packaged into a longrunning + [Operation][google.longrunning.Operation]. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, files]) + 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 cloud_speech.BatchRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.BatchRecognizeRequest): + request = cloud_speech.BatchRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if files is not None: + request.files = files + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.batch_recognize] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("recognizer", request.recognizer), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.BatchRecognizeResponse, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def get_config(self, + request: Optional[Union[cloud_speech.GetConfigRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Returns the requested [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_get_config(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetConfigRequest( + name="name_value", + ) + + # Make the request + response = client.get_config(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.GetConfigRequest, dict]): + The request object. Request message for the + [GetConfig][google.cloud.speech.v2.Speech.GetConfig] + method. + name (str): + Required. The name of the config to retrieve. There is + exactly one config resource per project per location. + The expected format is + ``projects/{project}/locations/{location}/config``. + + 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.speech_v2.types.Config: + Message representing the config for the Speech-to-Text API. This includes an + optional [KMS + key](\ https://cloud.google.com/kms/docs/resource-hierarchy#keys) + with which incoming data will be encrypted. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetConfigRequest): + request = cloud_speech.GetConfigRequest(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_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_config(self, + request: Optional[Union[cloud_speech.UpdateConfigRequest, dict]] = None, + *, + config: Optional[cloud_speech.Config] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Updates the [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_update_config(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateConfigRequest( + ) + + # Make the request + response = client.update_config(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UpdateConfigRequest, dict]): + The request object. Request message for the + [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] + method. + config (google.cloud.speech_v2.types.Config): + Required. The config to update. + + The config's ``name`` field is used to identify the + config to be updated. The expected format is + ``projects/{project}/locations/{location}/config``. + + This corresponds to the ``config`` 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.speech_v2.types.Config: + Message representing the config for the Speech-to-Text API. This includes an + optional [KMS + key](\ https://cloud.google.com/kms/docs/resource-hierarchy#keys) + with which incoming data will be encrypted. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UpdateConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateConfigRequest): + request = cloud_speech.UpdateConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("config.name", request.config.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_custom_class(self, + request: Optional[Union[cloud_speech.CreateCustomClassRequest, dict]] = None, + *, + parent: Optional[str] = None, + custom_class: Optional[cloud_speech.CustomClass] = None, + custom_class_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_create_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreateCustomClassRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.CreateCustomClassRequest, dict]): + The request object. Request message for the + [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] + method. + parent (str): + Required. The project and location where this + CustomClass will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (google.cloud.speech_v2.types.CustomClass): + Required. The CustomClass to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (str): + The ID to use for the CustomClass, which will become the + final component of the CustomClass's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreateCustomClassRequest): + request = cloud_speech.CreateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_custom_classes(self, + request: Optional[Union[cloud_speech.ListCustomClassesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesPager: + r"""Lists CustomClasses. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_list_custom_classes(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.ListCustomClassesRequest, dict]): + The request object. Request message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + parent (str): + Required. The project and location of CustomClass + resources to list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager: + Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListCustomClassesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListCustomClassesRequest): + request = cloud_speech.ListCustomClassesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_custom_classes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListCustomClassesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_custom_class(self, + request: Optional[Union[cloud_speech.GetCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.CustomClass: + r"""Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_get_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.GetCustomClassRequest, dict]): + The request object. Request message for the + [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] + method. + name (str): + Required. The name of the CustomClass to retrieve. The + expected format is + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + + 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.speech_v2.types.CustomClass: + CustomClass for biasing in speech + recognition. Used to define a set of + words or phrases that represents a + common concept or theme likely to appear + in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetCustomClassRequest): + request = cloud_speech.GetCustomClassRequest(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_custom_class] + + # 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_custom_class(self, + request: Optional[Union[cloud_speech.UpdateCustomClassRequest, dict]] = None, + *, + custom_class: Optional[cloud_speech.CustomClass] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_update_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateCustomClassRequest( + ) + + # Make the request + operation = client.update_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UpdateCustomClassRequest, dict]): + The request object. Request message for the + [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] + method. + custom_class (google.cloud.speech_v2.types.CustomClass): + Required. The CustomClass to update. + + The CustomClass's ``name`` field is used to identify the + CustomClass to update. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + + This corresponds to the ``custom_class`` 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. If + empty, all fields are considered for + update. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, 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 cloud_speech.UpdateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateCustomClassRequest): + request = cloud_speech.UpdateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + 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_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_custom_class(self, + request: Optional[Union[cloud_speech.DeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_delete_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.DeleteCustomClassRequest, dict]): + The request object. Request message for the + [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] + method. + name (str): + Required. The name of the CustomClass to delete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeleteCustomClassRequest): + request = cloud_speech.DeleteCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_custom_class(self, + request: Optional[Union[cloud_speech.UndeleteCustomClassRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_undelete_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UndeleteCustomClassRequest, dict]): + The request object. Request message for the + [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] + method. + name (str): + Required. The name of the CustomClass to undelete. + Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.CustomClass` CustomClass for biasing in speech recognition. Used to define a set of words + or phrases that represents a common concept or theme + likely to appear in your audio, for example a list of + passenger ship names. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeleteCustomClassRequest): + request = cloud_speech.UndeleteCustomClassRequest(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.undelete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def create_phrase_set(self, + request: Optional[Union[cloud_speech.CreatePhraseSetRequest, dict]] = None, + *, + parent: Optional[str] = None, + phrase_set: Optional[cloud_speech.PhraseSet] = None, + phrase_set_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_create_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreatePhraseSetRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.CreatePhraseSetRequest, dict]): + The request object. Request message for the + [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] + method. + parent (str): + Required. The project and location where this PhraseSet + will be created. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (google.cloud.speech_v2.types.PhraseSet): + Required. The PhraseSet to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (str): + The ID to use for the PhraseSet, which will become the + final component of the PhraseSet's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreatePhraseSetRequest): + request = cloud_speech.CreatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_phrase_sets(self, + request: Optional[Union[cloud_speech.ListPhraseSetsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetsPager: + r"""Lists PhraseSets. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_list_phrase_sets(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListPhraseSetsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_sets(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.ListPhraseSetsRequest, dict]): + The request object. Request message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + parent (str): + Required. The project and location of PhraseSet + resources to list. The expected format is + ``projects/{project}/locations/{location}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager: + Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListPhraseSetsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListPhraseSetsRequest): + request = cloud_speech.ListPhraseSetsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_phrase_sets] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListPhraseSetsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_phrase_set(self, + request: Optional[Union[cloud_speech.GetPhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.PhraseSet: + r"""Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_get_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.GetPhraseSetRequest, dict]): + The request object. Request message for the + [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] + method. + name (str): + Required. The name of the PhraseSet to retrieve. The + expected format is + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + + 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.speech_v2.types.PhraseSet: + PhraseSet for biasing in speech + recognition. A PhraseSet is used to + provide "hints" to the speech recognizer + to favor specific words and phrases in + the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetPhraseSetRequest): + request = cloud_speech.GetPhraseSetRequest(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_phrase_set] + + # 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_phrase_set(self, + request: Optional[Union[cloud_speech.UpdatePhraseSetRequest, dict]] = None, + *, + phrase_set: Optional[cloud_speech.PhraseSet] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_update_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdatePhraseSetRequest( + ) + + # Make the request + operation = client.update_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UpdatePhraseSetRequest, dict]): + The request object. Request message for the + [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] + method. + phrase_set (google.cloud.speech_v2.types.PhraseSet): + Required. The PhraseSet to update. + + The PhraseSet's ``name`` field is used to identify the + PhraseSet to update. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + + This corresponds to the ``phrase_set`` 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 update. If empty, all non-default + valued fields are considered for update. Use ``*`` to + update the entire PhraseSet resource. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, 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 cloud_speech.UpdatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdatePhraseSetRequest): + request = cloud_speech.UpdatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + 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_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_phrase_set(self, + request: Optional[Union[cloud_speech.DeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_delete_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.DeletePhraseSetRequest, dict]): + The request object. Request message for the + [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] + method. + name (str): + Required. The name of the PhraseSet to delete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeletePhraseSetRequest): + request = cloud_speech.DeletePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_phrase_set(self, + request: Optional[Union[cloud_speech.UndeletePhraseSetRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import speech_v2 + + def sample_undelete_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.speech_v2.types.UndeletePhraseSetRequest, dict]): + The request object. Request message for the + [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] + method. + name (str): + Required. The name of the PhraseSet to undelete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.speech_v2.types.PhraseSet` PhraseSet for biasing in speech recognition. A PhraseSet is used to provide + "hints" to the speech recognizer to favor specific + words and phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeletePhraseSetRequest): + request = cloud_speech.UndeletePhraseSetRequest(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.undelete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "SpeechClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.delete_operation, + 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. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.cancel_operation, + 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. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_location, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_locations, + 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 = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "SpeechClient", +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/pagers.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/pagers.py new file mode 100644 index 00000000..b3866eba --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/pagers.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.speech_v2.types import cloud_speech + + +class ListRecognizersPager: + """A pager for iterating through ``list_recognizers`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListRecognizersResponse` object, and + provides an ``__iter__`` method to iterate through its + ``recognizers`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRecognizers`` requests and continue to iterate + through the ``recognizers`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListRecognizersResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech.ListRecognizersResponse], + request: cloud_speech.ListRecognizersRequest, + response: cloud_speech.ListRecognizersResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListRecognizersRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListRecognizersResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListRecognizersRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListRecognizersResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.Recognizer]: + for page in self.pages: + yield from page.recognizers + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRecognizersAsyncPager: + """A pager for iterating through ``list_recognizers`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListRecognizersResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``recognizers`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRecognizers`` requests and continue to iterate + through the ``recognizers`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListRecognizersResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech.ListRecognizersResponse]], + request: cloud_speech.ListRecognizersRequest, + response: cloud_speech.ListRecognizersResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListRecognizersRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListRecognizersResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListRecognizersRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListRecognizersResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_speech.Recognizer]: + async def async_generator(): + async for page in self.pages: + for response in page.recognizers: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech.ListCustomClassesResponse], + request: cloud_speech.ListCustomClassesRequest, + response: cloud_speech.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.CustomClass]: + for page in self.pages: + yield from page.custom_classes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesAsyncPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech.ListCustomClassesResponse]], + request: cloud_speech.ListCustomClassesRequest, + response: cloud_speech.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_speech.CustomClass]: + async def async_generator(): + async for page in self.pages: + for response in page.custom_classes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListPhraseSetsPager: + """A pager for iterating through ``list_phrase_sets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListPhraseSets`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_speech.ListPhraseSetsResponse], + request: cloud_speech.ListPhraseSetsRequest, + response: cloud_speech.ListPhraseSetsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListPhraseSetsRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListPhraseSetsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListPhraseSetsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListPhraseSetsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.PhraseSet]: + for page in self.pages: + yield from page.phrase_sets + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListPhraseSetsAsyncPager: + """A pager for iterating through ``list_phrase_sets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListPhraseSets`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_speech.ListPhraseSetsResponse]], + request: cloud_speech.ListPhraseSetsRequest, + response: cloud_speech.ListPhraseSetsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListPhraseSetsRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListPhraseSetsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListPhraseSetsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListPhraseSetsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_speech.PhraseSet]: + async def async_generator(): + async for page in self.pages: + for response in page.phrase_sets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/__init__.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/__init__.py new file mode 100644 index 00000000..4bac8f03 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport +from .rest import SpeechRestTransport +from .rest import SpeechRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry['grpc'] = SpeechGrpcTransport +_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport +_transport_registry['rest'] = SpeechRestTransport + +__all__ = ( + 'SpeechTransport', + 'SpeechGrpcTransport', + 'SpeechGrpcAsyncIOTransport', + 'SpeechRestTransport', + 'SpeechRestInterceptor', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/base.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/base.py new file mode 100644 index 00000000..efdc8204 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/base.py @@ -0,0 +1,516 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.speech_v2 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_recognizer: gapic_v1.method.wrap_method( + self.create_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.list_recognizers: gapic_v1.method.wrap_method( + self.list_recognizers, + default_timeout=None, + client_info=client_info, + ), + self.get_recognizer: gapic_v1.method.wrap_method( + self.get_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.update_recognizer: gapic_v1.method.wrap_method( + self.update_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.delete_recognizer: gapic_v1.method.wrap_method( + self.delete_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.undelete_recognizer: gapic_v1.method.wrap_method( + self.undelete_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + default_timeout=None, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + default_timeout=None, + client_info=client_info, + ), + self.batch_recognize: gapic_v1.method.wrap_method( + self.batch_recognize, + default_timeout=None, + client_info=client_info, + ), + self.get_config: gapic_v1.method.wrap_method( + self.get_config, + default_timeout=None, + client_info=client_info, + ), + self.update_config: gapic_v1.method.wrap_method( + self.update_config, + default_timeout=None, + client_info=client_info, + ), + self.create_custom_class: gapic_v1.method.wrap_method( + self.create_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.list_custom_classes: gapic_v1.method.wrap_method( + self.list_custom_classes, + default_timeout=None, + client_info=client_info, + ), + self.get_custom_class: gapic_v1.method.wrap_method( + self.get_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.update_custom_class: gapic_v1.method.wrap_method( + self.update_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.delete_custom_class: gapic_v1.method.wrap_method( + self.delete_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.undelete_custom_class: gapic_v1.method.wrap_method( + self.undelete_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.create_phrase_set: gapic_v1.method.wrap_method( + self.create_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.list_phrase_sets: gapic_v1.method.wrap_method( + self.list_phrase_sets, + default_timeout=None, + client_info=client_info, + ), + self.get_phrase_set: gapic_v1.method.wrap_method( + self.get_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.update_phrase_set: gapic_v1.method.wrap_method( + self.update_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.delete_phrase_set: gapic_v1.method.wrap_method( + self.delete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.undelete_phrase_set: gapic_v1.method.wrap_method( + self.undelete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def create_recognizer(self) -> Callable[ + [cloud_speech.CreateRecognizerRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_recognizers(self) -> Callable[ + [cloud_speech.ListRecognizersRequest], + Union[ + cloud_speech.ListRecognizersResponse, + Awaitable[cloud_speech.ListRecognizersResponse] + ]]: + raise NotImplementedError() + + @property + def get_recognizer(self) -> Callable[ + [cloud_speech.GetRecognizerRequest], + Union[ + cloud_speech.Recognizer, + Awaitable[cloud_speech.Recognizer] + ]]: + raise NotImplementedError() + + @property + def update_recognizer(self) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_recognizer(self) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def undelete_recognizer(self) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, + Awaitable[cloud_speech.RecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def batch_recognize(self) -> Callable[ + [cloud_speech.BatchRecognizeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def get_config(self) -> Callable[ + [cloud_speech.GetConfigRequest], + Union[ + cloud_speech.Config, + Awaitable[cloud_speech.Config] + ]]: + raise NotImplementedError() + + @property + def update_config(self) -> Callable[ + [cloud_speech.UpdateConfigRequest], + Union[ + cloud_speech.Config, + Awaitable[cloud_speech.Config] + ]]: + raise NotImplementedError() + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech.CreateCustomClassRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + Union[ + cloud_speech.ListCustomClassesResponse, + Awaitable[cloud_speech.ListCustomClassesResponse] + ]]: + raise NotImplementedError() + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech.GetCustomClassRequest], + Union[ + cloud_speech.CustomClass, + Awaitable[cloud_speech.CustomClass] + ]]: + raise NotImplementedError() + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def undelete_custom_class(self) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_phrase_sets(self) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + Union[ + cloud_speech.ListPhraseSetsResponse, + Awaitable[cloud_speech.ListPhraseSetsResponse] + ]]: + raise NotImplementedError() + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech.GetPhraseSetRequest], + Union[ + cloud_speech.PhraseSet, + Awaitable[cloud_speech.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def undelete_phrase_set(self) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[ + [operations_pb2.CancelOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[ + [operations_pb2.DeleteOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def get_location(self, + ) -> Callable[ + [locations_pb2.GetLocationRequest], + Union[locations_pb2.Location, Awaitable[locations_pb2.Location]], + ]: + raise NotImplementedError() + + @property + def list_locations(self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], + Union[locations_pb2.ListLocationsResponse, Awaitable[locations_pb2.ListLocationsResponse]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'SpeechTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc.py new file mode 100644 index 00000000..bcd9b892 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc.py @@ -0,0 +1,975 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Enables speech transcription and resource management. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def create_recognizer(self) -> Callable[ + [cloud_speech.CreateRecognizerRequest], + operations_pb2.Operation]: + r"""Return a callable for the create recognizer method over gRPC. + + Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.CreateRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_recognizer' not in self._stubs: + self._stubs['create_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreateRecognizer', + request_serializer=cloud_speech.CreateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_recognizer'] + + @property + def list_recognizers(self) -> Callable[ + [cloud_speech.ListRecognizersRequest], + cloud_speech.ListRecognizersResponse]: + r"""Return a callable for the list recognizers method over gRPC. + + Lists Recognizers. + + Returns: + Callable[[~.ListRecognizersRequest], + ~.ListRecognizersResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_recognizers' not in self._stubs: + self._stubs['list_recognizers'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListRecognizers', + request_serializer=cloud_speech.ListRecognizersRequest.serialize, + response_deserializer=cloud_speech.ListRecognizersResponse.deserialize, + ) + return self._stubs['list_recognizers'] + + @property + def get_recognizer(self) -> Callable[ + [cloud_speech.GetRecognizerRequest], + cloud_speech.Recognizer]: + r"""Return a callable for the get recognizer method over gRPC. + + Returns the requested + [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with + [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested + Recognizer doesn't exist. + + Returns: + Callable[[~.GetRecognizerRequest], + ~.Recognizer]: + 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_recognizer' not in self._stubs: + self._stubs['get_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetRecognizer', + request_serializer=cloud_speech.GetRecognizerRequest.serialize, + response_deserializer=cloud_speech.Recognizer.deserialize, + ) + return self._stubs['get_recognizer'] + + @property + def update_recognizer(self) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], + operations_pb2.Operation]: + r"""Return a callable for the update recognizer method over gRPC. + + Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UpdateRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_recognizer' not in self._stubs: + self._stubs['update_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateRecognizer', + request_serializer=cloud_speech.UpdateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_recognizer'] + + @property + def delete_recognizer(self) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete recognizer method over gRPC. + + Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.DeleteRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_recognizer' not in self._stubs: + self._stubs['delete_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeleteRecognizer', + request_serializer=cloud_speech.DeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_recognizer'] + + @property + def undelete_recognizer(self) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], + operations_pb2.Operation]: + r"""Return a callable for the undelete recognizer method over gRPC. + + Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UndeleteRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_recognizer' not in self._stubs: + self._stubs['undelete_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeleteRecognizer', + request_serializer=cloud_speech.UndeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_recognizer'] + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v2.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + @property + def batch_recognize(self) -> Callable[ + [cloud_speech.BatchRecognizeRequest], + operations_pb2.Operation]: + r"""Return a callable for the batch recognize method over gRPC. + + Performs batch asynchronous speech recognition: send + a request with N audio files and receive a long running + operation that can be polled to see when the + transcriptions are finished. + + Returns: + Callable[[~.BatchRecognizeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'batch_recognize' not in self._stubs: + self._stubs['batch_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/BatchRecognize', + request_serializer=cloud_speech.BatchRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['batch_recognize'] + + @property + def get_config(self) -> Callable[ + [cloud_speech.GetConfigRequest], + cloud_speech.Config]: + r"""Return a callable for the get config method over gRPC. + + Returns the requested [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.GetConfigRequest], + ~.Config]: + 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_config' not in self._stubs: + self._stubs['get_config'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetConfig', + request_serializer=cloud_speech.GetConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs['get_config'] + + @property + def update_config(self) -> Callable[ + [cloud_speech.UpdateConfigRequest], + cloud_speech.Config]: + r"""Return a callable for the update config method over gRPC. + + Updates the [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.UpdateConfigRequest], + ~.Config]: + 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_config' not in self._stubs: + self._stubs['update_config'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateConfig', + request_serializer=cloud_speech.UpdateConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs['update_config'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech.CreateCustomClassRequest], + operations_pb2.Operation]: + r"""Return a callable for the create custom class method over gRPC. + + Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.CreateCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreateCustomClass', + request_serializer=cloud_speech.CreateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + cloud_speech.ListCustomClassesResponse]: + r"""Return a callable for the list custom classes method over gRPC. + + Lists CustomClasses. + + Returns: + Callable[[~.ListCustomClassesRequest], + ~.ListCustomClassesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListCustomClasses', + request_serializer=cloud_speech.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech.GetCustomClassRequest], + cloud_speech.CustomClass]: + r"""Return a callable for the get custom class method over gRPC. + + Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.GetCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetCustomClass', + request_serializer=cloud_speech.GetCustomClassRequest.serialize, + response_deserializer=cloud_speech.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], + operations_pb2.Operation]: + r"""Return a callable for the update custom class method over gRPC. + + Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UpdateCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateCustomClass', + request_serializer=cloud_speech.UpdateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete custom class method over gRPC. + + Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.DeleteCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeleteCustomClass', + request_serializer=cloud_speech.DeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_custom_class'] + + @property + def undelete_custom_class(self) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], + operations_pb2.Operation]: + r"""Return a callable for the undelete custom class method over gRPC. + + Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UndeleteCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_custom_class' not in self._stubs: + self._stubs['undelete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeleteCustomClass', + request_serializer=cloud_speech.UndeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_custom_class'] + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], + operations_pb2.Operation]: + r"""Return a callable for the create phrase set method over gRPC. + + Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.CreatePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreatePhraseSet', + request_serializer=cloud_speech.CreatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_phrase_set'] + + @property + def list_phrase_sets(self) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + cloud_speech.ListPhraseSetsResponse]: + r"""Return a callable for the list phrase sets method over gRPC. + + Lists PhraseSets. + + Returns: + Callable[[~.ListPhraseSetsRequest], + ~.ListPhraseSetsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_sets' not in self._stubs: + self._stubs['list_phrase_sets'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListPhraseSets', + request_serializer=cloud_speech.ListPhraseSetsRequest.serialize, + response_deserializer=cloud_speech.ListPhraseSetsResponse.deserialize, + ) + return self._stubs['list_phrase_sets'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech.GetPhraseSetRequest], + cloud_speech.PhraseSet]: + r"""Return a callable for the get phrase set method over gRPC. + + Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.GetPhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetPhraseSet', + request_serializer=cloud_speech.GetPhraseSetRequest.serialize, + response_deserializer=cloud_speech.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], + operations_pb2.Operation]: + r"""Return a callable for the update phrase set method over gRPC. + + Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdatePhraseSet', + request_serializer=cloud_speech.UpdatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete phrase set method over gRPC. + + Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.DeletePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeletePhraseSet', + request_serializer=cloud_speech.DeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def undelete_phrase_set(self) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], + operations_pb2.Operation]: + r"""Return a callable for the undelete phrase set method over gRPC. + + Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UndeletePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_phrase_set' not in self._stubs: + self._stubs['undelete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeletePhraseSet', + request_serializer=cloud_speech.UndeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_phrase_set'] + + def close(self): + self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # 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 "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # 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_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'SpeechGrpcTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py new file mode 100644 index 00000000..97f662a4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,974 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Enables speech transcription and resource management. + + 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 = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def create_recognizer(self) -> Callable[ + [cloud_speech.CreateRecognizerRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create recognizer method over gRPC. + + Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.CreateRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_recognizer' not in self._stubs: + self._stubs['create_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreateRecognizer', + request_serializer=cloud_speech.CreateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_recognizer'] + + @property + def list_recognizers(self) -> Callable[ + [cloud_speech.ListRecognizersRequest], + Awaitable[cloud_speech.ListRecognizersResponse]]: + r"""Return a callable for the list recognizers method over gRPC. + + Lists Recognizers. + + Returns: + Callable[[~.ListRecognizersRequest], + Awaitable[~.ListRecognizersResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_recognizers' not in self._stubs: + self._stubs['list_recognizers'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListRecognizers', + request_serializer=cloud_speech.ListRecognizersRequest.serialize, + response_deserializer=cloud_speech.ListRecognizersResponse.deserialize, + ) + return self._stubs['list_recognizers'] + + @property + def get_recognizer(self) -> Callable[ + [cloud_speech.GetRecognizerRequest], + Awaitable[cloud_speech.Recognizer]]: + r"""Return a callable for the get recognizer method over gRPC. + + Returns the requested + [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with + [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested + Recognizer doesn't exist. + + Returns: + Callable[[~.GetRecognizerRequest], + Awaitable[~.Recognizer]]: + 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_recognizer' not in self._stubs: + self._stubs['get_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetRecognizer', + request_serializer=cloud_speech.GetRecognizerRequest.serialize, + response_deserializer=cloud_speech.Recognizer.deserialize, + ) + return self._stubs['get_recognizer'] + + @property + def update_recognizer(self) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update recognizer method over gRPC. + + Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UpdateRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_recognizer' not in self._stubs: + self._stubs['update_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateRecognizer', + request_serializer=cloud_speech.UpdateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_recognizer'] + + @property + def delete_recognizer(self) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete recognizer method over gRPC. + + Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.DeleteRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_recognizer' not in self._stubs: + self._stubs['delete_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeleteRecognizer', + request_serializer=cloud_speech.DeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_recognizer'] + + @property + def undelete_recognizer(self) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the undelete recognizer method over gRPC. + + Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UndeleteRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_recognizer' not in self._stubs: + self._stubs['undelete_recognizer'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeleteRecognizer', + request_serializer=cloud_speech.UndeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_recognizer'] + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Awaitable[cloud_speech.RecognizeResponse]]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse]]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v2.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + @property + def batch_recognize(self) -> Callable[ + [cloud_speech.BatchRecognizeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the batch recognize method over gRPC. + + Performs batch asynchronous speech recognition: send + a request with N audio files and receive a long running + operation that can be polled to see when the + transcriptions are finished. + + Returns: + Callable[[~.BatchRecognizeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'batch_recognize' not in self._stubs: + self._stubs['batch_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/BatchRecognize', + request_serializer=cloud_speech.BatchRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['batch_recognize'] + + @property + def get_config(self) -> Callable[ + [cloud_speech.GetConfigRequest], + Awaitable[cloud_speech.Config]]: + r"""Return a callable for the get config method over gRPC. + + Returns the requested [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.GetConfigRequest], + Awaitable[~.Config]]: + 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_config' not in self._stubs: + self._stubs['get_config'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetConfig', + request_serializer=cloud_speech.GetConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs['get_config'] + + @property + def update_config(self) -> Callable[ + [cloud_speech.UpdateConfigRequest], + Awaitable[cloud_speech.Config]]: + r"""Return a callable for the update config method over gRPC. + + Updates the [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.UpdateConfigRequest], + Awaitable[~.Config]]: + 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_config' not in self._stubs: + self._stubs['update_config'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateConfig', + request_serializer=cloud_speech.UpdateConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs['update_config'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech.CreateCustomClassRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create custom class method over gRPC. + + Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.CreateCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreateCustomClass', + request_serializer=cloud_speech.CreateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + Awaitable[cloud_speech.ListCustomClassesResponse]]: + r"""Return a callable for the list custom classes method over gRPC. + + Lists CustomClasses. + + Returns: + Callable[[~.ListCustomClassesRequest], + Awaitable[~.ListCustomClassesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListCustomClasses', + request_serializer=cloud_speech.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech.GetCustomClassRequest], + Awaitable[cloud_speech.CustomClass]]: + r"""Return a callable for the get custom class method over gRPC. + + Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.GetCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetCustomClass', + request_serializer=cloud_speech.GetCustomClassRequest.serialize, + response_deserializer=cloud_speech.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update custom class method over gRPC. + + Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UpdateCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdateCustomClass', + request_serializer=cloud_speech.UpdateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete custom class method over gRPC. + + Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.DeleteCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeleteCustomClass', + request_serializer=cloud_speech.DeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_custom_class'] + + @property + def undelete_custom_class(self) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the undelete custom class method over gRPC. + + Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UndeleteCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_custom_class' not in self._stubs: + self._stubs['undelete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeleteCustomClass', + request_serializer=cloud_speech.UndeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_custom_class'] + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create phrase set method over gRPC. + + Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.CreatePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/CreatePhraseSet', + request_serializer=cloud_speech.CreatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_phrase_set'] + + @property + def list_phrase_sets(self) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + Awaitable[cloud_speech.ListPhraseSetsResponse]]: + r"""Return a callable for the list phrase sets method over gRPC. + + Lists PhraseSets. + + Returns: + Callable[[~.ListPhraseSetsRequest], + Awaitable[~.ListPhraseSetsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_phrase_sets' not in self._stubs: + self._stubs['list_phrase_sets'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/ListPhraseSets', + request_serializer=cloud_speech.ListPhraseSetsRequest.serialize, + response_deserializer=cloud_speech.ListPhraseSetsResponse.deserialize, + ) + return self._stubs['list_phrase_sets'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech.GetPhraseSetRequest], + Awaitable[cloud_speech.PhraseSet]]: + r"""Return a callable for the get phrase set method over gRPC. + + Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.GetPhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/GetPhraseSet', + request_serializer=cloud_speech.GetPhraseSetRequest.serialize, + response_deserializer=cloud_speech.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update phrase set method over gRPC. + + Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UpdatePhraseSet', + request_serializer=cloud_speech.UpdatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete phrase set method over gRPC. + + Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.DeletePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/DeletePhraseSet', + request_serializer=cloud_speech.DeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def undelete_phrase_set(self) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the undelete phrase set method over gRPC. + + Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UndeletePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'undelete_phrase_set' not in self._stubs: + self._stubs['undelete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v2.Speech/UndeletePhraseSet', + request_serializer=cloud_speech.UndeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['undelete_phrase_set'] + + def close(self): + return self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # 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 "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # 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_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + +__all__ = ( + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/rest.py b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/rest.py new file mode 100644 index 00000000..3c89a2c6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/services/speech/transports/rest.py @@ -0,0 +1,3377 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from google.cloud.location import locations_pb2 # type: ignore +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +from .base import SpeechTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class SpeechRestInterceptor: + """Interceptor for Speech. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the SpeechRestTransport. + + .. code-block:: python + class MyCustomSpeechInterceptor(SpeechRestInterceptor): + def pre_batch_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_recognizer(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_recognizer(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_recognizer(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_recognizer(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_recognizer(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_recognizer(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_custom_classes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_custom_classes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_phrase_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_phrase_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_recognizers(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_recognizers(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_recognize(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_recognize(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_undelete_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_undelete_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_undelete_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_undelete_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_undelete_recognizer(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_undelete_recognizer(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_custom_class(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_custom_class(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_phrase_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_phrase_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_recognizer(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_recognizer(self, response): + logging.log(f"Received response: {response}") + return response + + transport = SpeechRestTransport(interceptor=MyCustomSpeechInterceptor()) + client = SpeechClient(transport=transport) + + + """ + def pre_batch_recognize(self, request: cloud_speech.BatchRecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.BatchRecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_batch_recognize(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for batch_recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_create_custom_class(self, request: cloud_speech.CreateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.CreateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_create_custom_class(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for create_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_create_phrase_set(self, request: cloud_speech.CreatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.CreatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_create_phrase_set(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for create_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_create_recognizer(self, request: cloud_speech.CreateRecognizerRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.CreateRecognizerRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_recognizer + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_create_recognizer(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for create_recognizer + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_delete_custom_class(self, request: cloud_speech.DeleteCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.DeleteCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_delete_custom_class(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_delete_phrase_set(self, request: cloud_speech.DeletePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.DeletePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_delete_phrase_set(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_delete_recognizer(self, request: cloud_speech.DeleteRecognizerRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.DeleteRecognizerRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_recognizer + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_delete_recognizer(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_recognizer + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_get_config(self, request: cloud_speech.GetConfigRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.GetConfigRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_config(self, response: cloud_speech.Config) -> cloud_speech.Config: + """Post-rpc interceptor for get_config + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_get_custom_class(self, request: cloud_speech.GetCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.GetCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_custom_class(self, response: cloud_speech.CustomClass) -> cloud_speech.CustomClass: + """Post-rpc interceptor for get_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_get_phrase_set(self, request: cloud_speech.GetPhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.GetPhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_phrase_set(self, response: cloud_speech.PhraseSet) -> cloud_speech.PhraseSet: + """Post-rpc interceptor for get_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_get_recognizer(self, request: cloud_speech.GetRecognizerRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.GetRecognizerRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_recognizer + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_recognizer(self, response: cloud_speech.Recognizer) -> cloud_speech.Recognizer: + """Post-rpc interceptor for get_recognizer + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_custom_classes(self, request: cloud_speech.ListCustomClassesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.ListCustomClassesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_custom_classes(self, response: cloud_speech.ListCustomClassesResponse) -> cloud_speech.ListCustomClassesResponse: + """Post-rpc interceptor for list_custom_classes + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_phrase_sets(self, request: cloud_speech.ListPhraseSetsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.ListPhraseSetsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_phrase_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_phrase_sets(self, response: cloud_speech.ListPhraseSetsResponse) -> cloud_speech.ListPhraseSetsResponse: + """Post-rpc interceptor for list_phrase_sets + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_recognizers(self, request: cloud_speech.ListRecognizersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.ListRecognizersRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_recognizers + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_recognizers(self, response: cloud_speech.ListRecognizersResponse) -> cloud_speech.ListRecognizersResponse: + """Post-rpc interceptor for list_recognizers + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_recognize(self, request: cloud_speech.RecognizeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.RecognizeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for recognize + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_recognize(self, response: cloud_speech.RecognizeResponse) -> cloud_speech.RecognizeResponse: + """Post-rpc interceptor for recognize + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_undelete_custom_class(self, request: cloud_speech.UndeleteCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UndeleteCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for undelete_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_undelete_custom_class(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for undelete_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_undelete_phrase_set(self, request: cloud_speech.UndeletePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UndeletePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for undelete_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_undelete_phrase_set(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for undelete_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_undelete_recognizer(self, request: cloud_speech.UndeleteRecognizerRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UndeleteRecognizerRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for undelete_recognizer + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_undelete_recognizer(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for undelete_recognizer + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_update_config(self, request: cloud_speech.UpdateConfigRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UpdateConfigRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_update_config(self, response: cloud_speech.Config) -> cloud_speech.Config: + """Post-rpc interceptor for update_config + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_update_custom_class(self, request: cloud_speech.UpdateCustomClassRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UpdateCustomClassRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_update_custom_class(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_custom_class + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_update_phrase_set(self, request: cloud_speech.UpdatePhraseSetRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UpdatePhraseSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_update_phrase_set(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_phrase_set + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_update_recognizer(self, request: cloud_speech.UpdateRecognizerRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_speech.UpdateRecognizerRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_recognizer + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_update_recognizer(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_recognizer + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + def pre_get_location( + self, request: locations_pb2.GetLocationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[locations_pb2.GetLocationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_location + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_location( + self, response: locations_pb2.Location + ) -> locations_pb2.Location: + """Post-rpc interceptor for get_location + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_locations( + self, request: locations_pb2.ListLocationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[locations_pb2.ListLocationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_locations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_locations( + self, response: locations_pb2.ListLocationsResponse + ) -> locations_pb2.ListLocationsResponse: + """Post-rpc interceptor for list_locations + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_cancel_operation( + self, request: operations_pb2.CancelOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.CancelOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_cancel_operation( + self, response: None + ) -> None: + """Post-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_delete_operation( + self, request: operations_pb2.DeleteOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.DeleteOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_delete_operation( + self, response: None + ) -> None: + """Post-rpc interceptor for delete_operation + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Speech server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Speech server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class SpeechRestStub: + _session: AuthorizedSession + _host: str + _interceptor: SpeechRestInterceptor + + +class SpeechRestTransport(SpeechTransport): + """REST backend transport for Speech. + + Enables speech transcription and resource management. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[SpeechRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or SpeechRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.CancelOperation': [ + { + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}:cancel', + 'body': '*', + }, + ], + 'google.longrunning.Operations.DeleteOperation': [ + { + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v2") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _BatchRecognize(SpeechRestStub): + def __hash__(self): + return hash("BatchRecognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.BatchRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the batch recognize method over HTTP. + + Args: + request (~.cloud_speech.BatchRecognizeRequest): + The request object. Request message for the + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{recognizer=projects/*/locations/*/recognizers/*}:batchRecognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_batch_recognize(request, metadata) + pb_request = cloud_speech.BatchRecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_recognize(resp) + return resp + + class _CreateCustomClass(SpeechRestStub): + def __hash__(self): + return hash("CreateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.CreateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the create custom class method over HTTP. + + Args: + request (~.cloud_speech.CreateCustomClassRequest): + The request object. Request message for the + [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{parent=projects/*/locations/*}/customClasses', + 'body': 'custom_class', + }, + ] + request, metadata = self._interceptor.pre_create_custom_class(request, metadata) + pb_request = cloud_speech.CreateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_custom_class(resp) + return resp + + class _CreatePhraseSet(SpeechRestStub): + def __hash__(self): + return hash("CreatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.CreatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the create phrase set method over HTTP. + + Args: + request (~.cloud_speech.CreatePhraseSetRequest): + The request object. Request message for the + [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{parent=projects/*/locations/*}/phraseSets', + 'body': 'phrase_set', + }, + ] + request, metadata = self._interceptor.pre_create_phrase_set(request, metadata) + pb_request = cloud_speech.CreatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_phrase_set(resp) + return resp + + class _CreateRecognizer(SpeechRestStub): + def __hash__(self): + return hash("CreateRecognizer") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.CreateRecognizerRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the create recognizer method over HTTP. + + Args: + request (~.cloud_speech.CreateRecognizerRequest): + The request object. Request message for the + [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{parent=projects/*/locations/*}/recognizers', + 'body': 'recognizer', + }, + ] + request, metadata = self._interceptor.pre_create_recognizer(request, metadata) + pb_request = cloud_speech.CreateRecognizerRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_recognizer(resp) + return resp + + class _DeleteCustomClass(SpeechRestStub): + def __hash__(self): + return hash("DeleteCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.DeleteCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete custom class method over HTTP. + + Args: + request (~.cloud_speech.DeleteCustomClassRequest): + The request object. Request message for the + [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_custom_class(request, metadata) + pb_request = cloud_speech.DeleteCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_custom_class(resp) + return resp + + class _DeletePhraseSet(SpeechRestStub): + def __hash__(self): + return hash("DeletePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.DeletePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete phrase set method over HTTP. + + Args: + request (~.cloud_speech.DeletePhraseSetRequest): + The request object. Request message for the + [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_phrase_set(request, metadata) + pb_request = cloud_speech.DeletePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_phrase_set(resp) + return resp + + class _DeleteRecognizer(SpeechRestStub): + def __hash__(self): + return hash("DeleteRecognizer") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.DeleteRecognizerRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete recognizer method over HTTP. + + Args: + request (~.cloud_speech.DeleteRecognizerRequest): + The request object. Request message for the + [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/recognizers/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_recognizer(request, metadata) + pb_request = cloud_speech.DeleteRecognizerRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_recognizer(resp) + return resp + + class _GetConfig(SpeechRestStub): + def __hash__(self): + return hash("GetConfig") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.GetConfigRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.Config: + r"""Call the get config method over HTTP. + + Args: + request (~.cloud_speech.GetConfigRequest): + The request object. Request message for the + [GetConfig][google.cloud.speech.v2.Speech.GetConfig] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.Config: + Message representing the config for the Speech-to-Text + API. This includes an optional `KMS + key `__ + with which incoming data will be encrypted. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/config}', + }, + ] + request, metadata = self._interceptor.pre_get_config(request, metadata) + pb_request = cloud_speech.GetConfigRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.Config() + pb_resp = cloud_speech.Config.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_config(resp) + return resp + + class _GetCustomClass(SpeechRestStub): + def __hash__(self): + return hash("GetCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.GetCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.CustomClass: + r"""Call the get custom class method over HTTP. + + Args: + request (~.cloud_speech.GetCustomClassRequest): + The request object. Request message for the + [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.CustomClass: + CustomClass for biasing in speech + recognition. Used to define a set of + words or phrases that represents a + common concept or theme likely to appear + in your audio, for example a list of + passenger ship names. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/customClasses/*}', + }, + ] + request, metadata = self._interceptor.pre_get_custom_class(request, metadata) + pb_request = cloud_speech.GetCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.CustomClass() + pb_resp = cloud_speech.CustomClass.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_custom_class(resp) + return resp + + class _GetPhraseSet(SpeechRestStub): + def __hash__(self): + return hash("GetPhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.GetPhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.PhraseSet: + r"""Call the get phrase set method over HTTP. + + Args: + request (~.cloud_speech.GetPhraseSetRequest): + The request object. Request message for the + [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.PhraseSet: + PhraseSet for biasing in speech + recognition. A PhraseSet is used to + provide "hints" to the speech recognizer + to favor specific words and phrases in + the results. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/phraseSets/*}', + }, + ] + request, metadata = self._interceptor.pre_get_phrase_set(request, metadata) + pb_request = cloud_speech.GetPhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.PhraseSet() + pb_resp = cloud_speech.PhraseSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_phrase_set(resp) + return resp + + class _GetRecognizer(SpeechRestStub): + def __hash__(self): + return hash("GetRecognizer") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.GetRecognizerRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.Recognizer: + r"""Call the get recognizer method over HTTP. + + Args: + request (~.cloud_speech.GetRecognizerRequest): + The request object. Request message for the + [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.Recognizer: + A Recognizer message. Stores + recognition configuration and metadata. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/recognizers/*}', + }, + ] + request, metadata = self._interceptor.pre_get_recognizer(request, metadata) + pb_request = cloud_speech.GetRecognizerRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.Recognizer() + pb_resp = cloud_speech.Recognizer.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_recognizer(resp) + return resp + + class _ListCustomClasses(SpeechRestStub): + def __hash__(self): + return hash("ListCustomClasses") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.ListCustomClassesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.ListCustomClassesResponse: + r"""Call the list custom classes method over HTTP. + + Args: + request (~.cloud_speech.ListCustomClassesRequest): + The request object. Request message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.ListCustomClassesResponse: + Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/customClasses', + }, + ] + request, metadata = self._interceptor.pre_list_custom_classes(request, metadata) + pb_request = cloud_speech.ListCustomClassesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.ListCustomClassesResponse() + pb_resp = cloud_speech.ListCustomClassesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_custom_classes(resp) + return resp + + class _ListPhraseSets(SpeechRestStub): + def __hash__(self): + return hash("ListPhraseSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.ListPhraseSetsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.ListPhraseSetsResponse: + r"""Call the list phrase sets method over HTTP. + + Args: + request (~.cloud_speech.ListPhraseSetsRequest): + The request object. Request message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.ListPhraseSetsResponse: + Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/phraseSets', + }, + ] + request, metadata = self._interceptor.pre_list_phrase_sets(request, metadata) + pb_request = cloud_speech.ListPhraseSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.ListPhraseSetsResponse() + pb_resp = cloud_speech.ListPhraseSetsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_phrase_sets(resp) + return resp + + class _ListRecognizers(SpeechRestStub): + def __hash__(self): + return hash("ListRecognizers") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.ListRecognizersRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.ListRecognizersResponse: + r"""Call the list recognizers method over HTTP. + + Args: + request (~.cloud_speech.ListRecognizersRequest): + The request object. Request message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.ListRecognizersResponse: + Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/recognizers', + }, + ] + request, metadata = self._interceptor.pre_list_recognizers(request, metadata) + pb_request = cloud_speech.ListRecognizersRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.ListRecognizersResponse() + pb_resp = cloud_speech.ListRecognizersResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_recognizers(resp) + return resp + + class _Recognize(SpeechRestStub): + def __hash__(self): + return hash("Recognize") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.RecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.RecognizeResponse: + r"""Call the recognize method over HTTP. + + Args: + request (~.cloud_speech.RecognizeRequest): + The request object. Request message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. Either ``content`` or ``uri`` must be supplied. + Supplying both or neither returns + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + 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: + ~.cloud_speech.RecognizeResponse: + Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{recognizer=projects/*/locations/*/recognizers/*}:recognize', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_recognize(request, metadata) + pb_request = cloud_speech.RecognizeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.RecognizeResponse() + pb_resp = cloud_speech.RecognizeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_recognize(resp) + return resp + + class _StreamingRecognize(SpeechRestStub): + def __hash__(self): + return hash("StreamingRecognize") + + def __call__(self, + request: cloud_speech.StreamingRecognizeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> rest_streaming.ResponseIterator: + raise NotImplementedError( + "Method StreamingRecognize is not available over REST transport" + ) + class _UndeleteCustomClass(SpeechRestStub): + def __hash__(self): + return hash("UndeleteCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UndeleteCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the undelete custom class method over HTTP. + + Args: + request (~.cloud_speech.UndeleteCustomClassRequest): + The request object. Request message for the + [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/customClasses/*}:undelete', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_undelete_custom_class(request, metadata) + pb_request = cloud_speech.UndeleteCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_undelete_custom_class(resp) + return resp + + class _UndeletePhraseSet(SpeechRestStub): + def __hash__(self): + return hash("UndeletePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UndeletePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the undelete phrase set method over HTTP. + + Args: + request (~.cloud_speech.UndeletePhraseSetRequest): + The request object. Request message for the + [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/phraseSets/*}:undelete', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_undelete_phrase_set(request, metadata) + pb_request = cloud_speech.UndeletePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_undelete_phrase_set(resp) + return resp + + class _UndeleteRecognizer(SpeechRestStub): + def __hash__(self): + return hash("UndeleteRecognizer") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UndeleteRecognizerRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the undelete recognizer method over HTTP. + + Args: + request (~.cloud_speech.UndeleteRecognizerRequest): + The request object. Request message for the + [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/recognizers/*}:undelete', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_undelete_recognizer(request, metadata) + pb_request = cloud_speech.UndeleteRecognizerRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_undelete_recognizer(resp) + return resp + + class _UpdateConfig(SpeechRestStub): + def __hash__(self): + return hash("UpdateConfig") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UpdateConfigRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_speech.Config: + r"""Call the update config method over HTTP. + + Args: + request (~.cloud_speech.UpdateConfigRequest): + The request object. Request message for the + [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_speech.Config: + Message representing the config for the Speech-to-Text + API. This includes an optional `KMS + key `__ + with which incoming data will be encrypted. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v2/{config.name=projects/*/locations/*/config}', + 'body': 'config', + }, + ] + request, metadata = self._interceptor.pre_update_config(request, metadata) + pb_request = cloud_speech.UpdateConfigRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_speech.Config() + pb_resp = cloud_speech.Config.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_config(resp) + return resp + + class _UpdateCustomClass(SpeechRestStub): + def __hash__(self): + return hash("UpdateCustomClass") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UpdateCustomClassRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update custom class method over HTTP. + + Args: + request (~.cloud_speech.UpdateCustomClassRequest): + The request object. Request message for the + [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v2/{custom_class.name=projects/*/locations/*/customClasses/*}', + 'body': 'custom_class', + }, + ] + request, metadata = self._interceptor.pre_update_custom_class(request, metadata) + pb_request = cloud_speech.UpdateCustomClassRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_custom_class(resp) + return resp + + class _UpdatePhraseSet(SpeechRestStub): + def __hash__(self): + return hash("UpdatePhraseSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UpdatePhraseSetRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update phrase set method over HTTP. + + Args: + request (~.cloud_speech.UpdatePhraseSetRequest): + The request object. Request message for the + [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v2/{phrase_set.name=projects/*/locations/*/phraseSets/*}', + 'body': 'phrase_set', + }, + ] + request, metadata = self._interceptor.pre_update_phrase_set(request, metadata) + pb_request = cloud_speech.UpdatePhraseSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_phrase_set(resp) + return resp + + class _UpdateRecognizer(SpeechRestStub): + def __hash__(self): + return hash("UpdateRecognizer") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_speech.UpdateRecognizerRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update recognizer method over HTTP. + + Args: + request (~.cloud_speech.UpdateRecognizerRequest): + The request object. Request message for the + [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v2/{recognizer.name=projects/*/locations/*/recognizers/*}', + 'body': 'recognizer', + }, + ] + request, metadata = self._interceptor.pre_update_recognizer(request, metadata) + pb_request = cloud_speech.UpdateRecognizerRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_recognizer(resp) + return resp + + @property + def batch_recognize(self) -> Callable[ + [cloud_speech.BatchRecognizeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech.CreateCustomClassRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_recognizer(self) -> Callable[ + [cloud_speech.CreateRecognizerRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateRecognizer(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeletePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_recognizer(self) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteRecognizer(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_config(self) -> Callable[ + [cloud_speech.GetConfigRequest], + cloud_speech.Config]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech.GetCustomClassRequest], + cloud_speech.CustomClass]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech.GetPhraseSetRequest], + cloud_speech.PhraseSet]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetPhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_recognizer(self) -> Callable[ + [cloud_speech.GetRecognizerRequest], + cloud_speech.Recognizer]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetRecognizer(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + cloud_speech.ListCustomClassesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListCustomClasses(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_phrase_sets(self) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + cloud_speech.ListPhraseSetsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListPhraseSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_recognizers(self) -> Callable[ + [cloud_speech.ListRecognizersRequest], + cloud_speech.ListRecognizersResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListRecognizers(self._session, self._host, self._interceptor) # type: ignore + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._Recognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._StreamingRecognize(self._session, self._host, self._interceptor) # type: ignore + + @property + def undelete_custom_class(self) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UndeleteCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def undelete_phrase_set(self) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UndeletePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def undelete_recognizer(self) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UndeleteRecognizer(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_config(self) -> Callable[ + [cloud_speech.UpdateConfigRequest], + cloud_speech.Config]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateCustomClass(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdatePhraseSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_recognizer(self) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateRecognizer(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_location(self): + return self._GetLocation(self._session, self._host, self._interceptor) # type: ignore + + class _GetLocation(SpeechRestStub): + def __call__(self, + request: locations_pb2.GetLocationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> locations_pb2.Location: + + r"""Call the get location method over HTTP. + + Args: + request (locations_pb2.GetLocationRequest): + The request object for GetLocation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + locations_pb2.Location: Response from GetLocation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}', + }, + ] + + request, metadata = self._interceptor.pre_get_location(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = locations_pb2.Location() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_location(resp) + return resp + + @property + def list_locations(self): + return self._ListLocations(self._session, self._host, self._interceptor) # type: ignore + + class _ListLocations(SpeechRestStub): + def __call__(self, + request: locations_pb2.ListLocationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> locations_pb2.ListLocationsResponse: + + r"""Call the list locations method over HTTP. + + Args: + request (locations_pb2.ListLocationsRequest): + The request object for ListLocations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + locations_pb2.ListLocationsResponse: Response from ListLocations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*}/locations', + }, + ] + + request, metadata = self._interceptor.pre_list_locations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = locations_pb2.ListLocationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_locations(resp) + return resp + + @property + def cancel_operation(self): + return self._CancelOperation(self._session, self._host, self._interceptor) # type: ignore + + class _CancelOperation(SpeechRestStub): + def __call__(self, + request: operations_pb2.CancelOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> None: + + r"""Call the cancel operation method over HTTP. + + Args: + request (operations_pb2.CancelOperationRequest): + The request object for CancelOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}:cancel', + 'body': '*', + }, + ] + + request, metadata = self._interceptor.pre_cancel_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + body = json.dumps(transcoded_request['body']) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + return self._interceptor.post_cancel_operation(None) + + @property + def delete_operation(self): + return self._DeleteOperation(self._session, self._host, self._interceptor) # type: ignore + + class _DeleteOperation(SpeechRestStub): + def __call__(self, + request: operations_pb2.DeleteOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> None: + + r"""Call the delete operation method over HTTP. + + Args: + request (operations_pb2.DeleteOperationRequest): + The request object for DeleteOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ] + + request, metadata = self._interceptor.pre_delete_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + return self._interceptor.post_delete_operation(None) + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(SpeechRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(SpeechRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'SpeechRestTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/types/__init__.py b/owl-bot-staging/v2/google/cloud/speech_v2/types/__init__.py new file mode 100644 index 00000000..90c46193 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/types/__init__.py @@ -0,0 +1,136 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .cloud_speech import ( + AutoDetectDecodingConfig, + BatchRecognizeFileMetadata, + BatchRecognizeFileResult, + BatchRecognizeMetadata, + BatchRecognizeRequest, + BatchRecognizeResponse, + BatchRecognizeResults, + BatchRecognizeTranscriptionMetadata, + CloudStorageResult, + Config, + CreateCustomClassRequest, + CreatePhraseSetRequest, + CreateRecognizerRequest, + CustomClass, + DeleteCustomClassRequest, + DeletePhraseSetRequest, + DeleteRecognizerRequest, + ExplicitDecodingConfig, + GcsOutputConfig, + GetConfigRequest, + GetCustomClassRequest, + GetPhraseSetRequest, + GetRecognizerRequest, + InlineOutputConfig, + InlineResult, + ListCustomClassesRequest, + ListCustomClassesResponse, + ListPhraseSetsRequest, + ListPhraseSetsResponse, + ListRecognizersRequest, + ListRecognizersResponse, + OperationMetadata, + PhraseSet, + RecognitionConfig, + RecognitionFeatures, + RecognitionOutputConfig, + RecognitionResponseMetadata, + Recognizer, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechAdaptation, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionFeatures, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + TranscriptNormalization, + UndeleteCustomClassRequest, + UndeletePhraseSetRequest, + UndeleteRecognizerRequest, + UpdateConfigRequest, + UpdateCustomClassRequest, + UpdatePhraseSetRequest, + UpdateRecognizerRequest, + WordInfo, +) + +__all__ = ( + 'AutoDetectDecodingConfig', + 'BatchRecognizeFileMetadata', + 'BatchRecognizeFileResult', + 'BatchRecognizeMetadata', + 'BatchRecognizeRequest', + 'BatchRecognizeResponse', + 'BatchRecognizeResults', + 'BatchRecognizeTranscriptionMetadata', + 'CloudStorageResult', + 'Config', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'CreateRecognizerRequest', + 'CustomClass', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'DeleteRecognizerRequest', + 'ExplicitDecodingConfig', + 'GcsOutputConfig', + 'GetConfigRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'GetRecognizerRequest', + 'InlineOutputConfig', + 'InlineResult', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetsRequest', + 'ListPhraseSetsResponse', + 'ListRecognizersRequest', + 'ListRecognizersResponse', + 'OperationMetadata', + 'PhraseSet', + 'RecognitionConfig', + 'RecognitionFeatures', + 'RecognitionOutputConfig', + 'RecognitionResponseMetadata', + 'Recognizer', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechAdaptation', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionFeatures', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptNormalization', + 'UndeleteCustomClassRequest', + 'UndeletePhraseSetRequest', + 'UndeleteRecognizerRequest', + 'UpdateConfigRequest', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'UpdateRecognizerRequest', + 'WordInfo', +) diff --git a/owl-bot-staging/v2/google/cloud/speech_v2/types/cloud_speech.py b/owl-bot-staging/v2/google/cloud/speech_v2/types/cloud_speech.py new file mode 100644 index 00000000..2a6bcb61 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/speech_v2/types/cloud_speech.py @@ -0,0 +1,3234 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import duration_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 + + +__protobuf__ = proto.module( + package='google.cloud.speech.v2', + manifest={ + 'CreateRecognizerRequest', + 'OperationMetadata', + 'ListRecognizersRequest', + 'ListRecognizersResponse', + 'GetRecognizerRequest', + 'UpdateRecognizerRequest', + 'DeleteRecognizerRequest', + 'UndeleteRecognizerRequest', + 'Recognizer', + 'AutoDetectDecodingConfig', + 'ExplicitDecodingConfig', + 'SpeakerDiarizationConfig', + 'RecognitionFeatures', + 'TranscriptNormalization', + 'SpeechAdaptation', + 'RecognitionConfig', + 'RecognizeRequest', + 'RecognitionResponseMetadata', + 'SpeechRecognitionAlternative', + 'WordInfo', + 'SpeechRecognitionResult', + 'RecognizeResponse', + 'StreamingRecognitionFeatures', + 'StreamingRecognitionConfig', + 'StreamingRecognizeRequest', + 'BatchRecognizeRequest', + 'GcsOutputConfig', + 'InlineOutputConfig', + 'RecognitionOutputConfig', + 'BatchRecognizeResponse', + 'BatchRecognizeResults', + 'CloudStorageResult', + 'InlineResult', + 'BatchRecognizeFileResult', + 'BatchRecognizeTranscriptionMetadata', + 'BatchRecognizeMetadata', + 'BatchRecognizeFileMetadata', + 'StreamingRecognitionResult', + 'StreamingRecognizeResponse', + 'Config', + 'GetConfigRequest', + 'UpdateConfigRequest', + 'CustomClass', + 'PhraseSet', + 'CreateCustomClassRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'GetCustomClassRequest', + 'UpdateCustomClassRequest', + 'DeleteCustomClassRequest', + 'UndeleteCustomClassRequest', + 'CreatePhraseSetRequest', + 'ListPhraseSetsRequest', + 'ListPhraseSetsResponse', + 'GetPhraseSetRequest', + 'UpdatePhraseSetRequest', + 'DeletePhraseSetRequest', + 'UndeletePhraseSetRequest', + }, +) + + +class CreateRecognizerRequest(proto.Message): + r"""Request message for the + [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] + method. + + Attributes: + recognizer (google.cloud.speech_v2.types.Recognizer): + Required. The Recognizer to create. + validate_only (bool): + If set, validate the request and preview the + Recognizer, but do not actually create it. + recognizer_id (str): + The ID to use for the Recognizer, which will become the + final component of the Recognizer's resource name. + + This value should be 4-63 characters, and valid characters + are /[a-z][0-9]-/. + parent (str): + Required. The project and location where this Recognizer + will be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + recognizer: 'Recognizer' = proto.Field( + proto.MESSAGE, + number=1, + message='Recognizer', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + recognizer_id: str = proto.Field( + proto.STRING, + number=3, + ) + parent: str = proto.Field( + proto.STRING, + number=4, + ) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of a long-running operation. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was last updated. + resource (str): + The resource path for the target of the + operation. + method (str): + The method that triggered the operation. + kms_key_name (str): + The `KMS key + name `__ + with which the content of the Operation is encrypted. The + expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + The `KMS key version + name `__ + with which content of the Operation is encrypted. The + expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + batch_recognize_request (google.cloud.speech_v2.types.BatchRecognizeRequest): + The BatchRecognizeRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + create_recognizer_request (google.cloud.speech_v2.types.CreateRecognizerRequest): + The CreateRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_recognizer_request (google.cloud.speech_v2.types.UpdateRecognizerRequest): + The UpdateRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_recognizer_request (google.cloud.speech_v2.types.DeleteRecognizerRequest): + The DeleteRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_recognizer_request (google.cloud.speech_v2.types.UndeleteRecognizerRequest): + The UndeleteRecognizerRequest that spawned + the Operation. + + This field is a member of `oneof`_ ``request``. + create_custom_class_request (google.cloud.speech_v2.types.CreateCustomClassRequest): + The CreateCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_custom_class_request (google.cloud.speech_v2.types.UpdateCustomClassRequest): + The UpdateCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_custom_class_request (google.cloud.speech_v2.types.DeleteCustomClassRequest): + The DeleteCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_custom_class_request (google.cloud.speech_v2.types.UndeleteCustomClassRequest): + The UndeleteCustomClassRequest that spawned + the Operation. + + This field is a member of `oneof`_ ``request``. + create_phrase_set_request (google.cloud.speech_v2.types.CreatePhraseSetRequest): + The CreatePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_phrase_set_request (google.cloud.speech_v2.types.UpdatePhraseSetRequest): + The UpdatePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_phrase_set_request (google.cloud.speech_v2.types.DeletePhraseSetRequest): + The DeletePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_phrase_set_request (google.cloud.speech_v2.types.UndeletePhraseSetRequest): + The UndeletePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_config_request (google.cloud.speech_v2.types.UpdateConfigRequest): + The UpdateConfigRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + progress_percent (int): + The percent progress of the Operation. Values + can range from 0-100. If the value is 100, then + the operation is finished. + batch_recognize_metadata (google.cloud.speech_v2.types.BatchRecognizeMetadata): + Metadata specific to the BatchRecognize + method. + + This field is a member of `oneof`_ ``metadata``. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + resource: str = proto.Field( + proto.STRING, + number=3, + ) + method: str = proto.Field( + proto.STRING, + number=4, + ) + kms_key_name: str = proto.Field( + proto.STRING, + number=6, + ) + kms_key_version_name: str = proto.Field( + proto.STRING, + number=7, + ) + batch_recognize_request: 'BatchRecognizeRequest' = proto.Field( + proto.MESSAGE, + number=8, + oneof='request', + message='BatchRecognizeRequest', + ) + create_recognizer_request: 'CreateRecognizerRequest' = proto.Field( + proto.MESSAGE, + number=9, + oneof='request', + message='CreateRecognizerRequest', + ) + update_recognizer_request: 'UpdateRecognizerRequest' = proto.Field( + proto.MESSAGE, + number=10, + oneof='request', + message='UpdateRecognizerRequest', + ) + delete_recognizer_request: 'DeleteRecognizerRequest' = proto.Field( + proto.MESSAGE, + number=11, + oneof='request', + message='DeleteRecognizerRequest', + ) + undelete_recognizer_request: 'UndeleteRecognizerRequest' = proto.Field( + proto.MESSAGE, + number=12, + oneof='request', + message='UndeleteRecognizerRequest', + ) + create_custom_class_request: 'CreateCustomClassRequest' = proto.Field( + proto.MESSAGE, + number=13, + oneof='request', + message='CreateCustomClassRequest', + ) + update_custom_class_request: 'UpdateCustomClassRequest' = proto.Field( + proto.MESSAGE, + number=14, + oneof='request', + message='UpdateCustomClassRequest', + ) + delete_custom_class_request: 'DeleteCustomClassRequest' = proto.Field( + proto.MESSAGE, + number=15, + oneof='request', + message='DeleteCustomClassRequest', + ) + undelete_custom_class_request: 'UndeleteCustomClassRequest' = proto.Field( + proto.MESSAGE, + number=16, + oneof='request', + message='UndeleteCustomClassRequest', + ) + create_phrase_set_request: 'CreatePhraseSetRequest' = proto.Field( + proto.MESSAGE, + number=17, + oneof='request', + message='CreatePhraseSetRequest', + ) + update_phrase_set_request: 'UpdatePhraseSetRequest' = proto.Field( + proto.MESSAGE, + number=18, + oneof='request', + message='UpdatePhraseSetRequest', + ) + delete_phrase_set_request: 'DeletePhraseSetRequest' = proto.Field( + proto.MESSAGE, + number=19, + oneof='request', + message='DeletePhraseSetRequest', + ) + undelete_phrase_set_request: 'UndeletePhraseSetRequest' = proto.Field( + proto.MESSAGE, + number=20, + oneof='request', + message='UndeletePhraseSetRequest', + ) + update_config_request: 'UpdateConfigRequest' = proto.Field( + proto.MESSAGE, + number=21, + oneof='request', + message='UpdateConfigRequest', + ) + progress_percent: int = proto.Field( + proto.INT32, + number=22, + ) + batch_recognize_metadata: 'BatchRecognizeMetadata' = proto.Field( + proto.MESSAGE, + number=23, + oneof='metadata', + message='BatchRecognizeMetadata', + ) + + +class ListRecognizersRequest(proto.Message): + r"""Request message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Attributes: + parent (str): + Required. The project and location of Recognizers to list. + The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + The maximum number of Recognizers to return. + The service may return fewer than this value. If + unspecified, at most 5 Recognizers will be + returned. The maximum value is 100; values above + 100 will be coerced to 100. + page_token (str): + A page token, received from a previous + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + show_deleted: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListRecognizersResponse(proto.Message): + r"""Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Attributes: + recognizers (MutableSequence[google.cloud.speech_v2.types.Recognizer]): + The list of requested Recognizers. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListRecognizersRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + recognizers: MutableSequence['Recognizer'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Recognizer', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRecognizerRequest(proto.Message): + r"""Request message for the + [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] method. + + Attributes: + name (str): + Required. The name of the Recognizer to retrieve. The + expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateRecognizerRequest(proto.Message): + r"""Request message for the + [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] + method. + + Attributes: + recognizer (google.cloud.speech_v2.types.Recognizer): + Required. The Recognizer to update. + + The Recognizer's ``name`` field is used to identify the + Recognizer to update. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to update. If empty, all non-default + valued fields are considered for update. Use ``*`` to update + the entire Recognizer resource. + validate_only (bool): + If set, validate the request and preview the + updated Recognizer, but do not actually update + it. + """ + + recognizer: 'Recognizer' = proto.Field( + proto.MESSAGE, + number=1, + message='Recognizer', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeleteRecognizerRequest(proto.Message): + r"""Request message for the + [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] + method. + + Attributes: + name (str): + Required. The name of the Recognizer to delete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + validate_only (bool): + If set, validate the request and preview the + deleted Recognizer, but do not actually delete + it. + allow_missing (bool): + If set to true, and the Recognizer is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing: bool = proto.Field( + proto.BOOL, + number=4, + ) + etag: str = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeleteRecognizerRequest(proto.Message): + r"""Request message for the + [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] + method. + + Attributes: + name (str): + Required. The name of the Recognizer to undelete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + validate_only (bool): + If set, validate the request and preview the + undeleted Recognizer, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=3, + ) + etag: str = proto.Field( + proto.STRING, + number=4, + ) + + +class Recognizer(proto.Message): + r"""A Recognizer message. Stores recognition configuration and + metadata. + + Attributes: + name (str): + Output only. The resource name of the Recognizer. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + uid (str): + Output only. System-assigned unique + identifier for the Recognizer. + display_name (str): + User-settable, human-readable name for the + Recognizer. Must be 63 characters or less. + model (str): + Optional. This field is now deprecated. Prefer the + [``model``][google.cloud.speech.v2.RecognitionConfig.model] + field in the + [``RecognitionConfig``][google.cloud.speech.v2.RecognitionConfig] + message. + + Which model to use for recognition requests. Select the + model best suited to your domain to get best results. + + Guidance for choosing which model to use can be found in the + `Transcription Models + Documentation `__ + and the models supported in each region can be found in the + `Table Of Supported + Models `__. + language_codes (MutableSequence[str]): + Optional. This field is now deprecated. Prefer the + [``language_codes``][google.cloud.speech.v2.RecognitionConfig.language_codes] + field in the + [``RecognitionConfig``][google.cloud.speech.v2.RecognitionConfig] + message. + + The language of the supplied audio as a + `BCP-47 `__ + language tag. + + Supported languages for each model are listed in the `Table + of Supported + Models `__. + + If additional languages are provided, recognition result + will contain recognition in the most likely language + detected. The recognition result will include the language + tag of the language detected in the audio. When you create + or update a Recognizer, these values are stored in + normalized BCP-47 form. For example, "en-us" is stored as + "en-US". + default_recognition_config (google.cloud.speech_v2.types.RecognitionConfig): + Default configuration to use for requests with this + Recognizer. This can be overwritten by inline configuration + in the + [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] + field. + annotations (MutableMapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + state (google.cloud.speech_v2.types.Recognizer.State): + Output only. The Recognizer lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + Recognizer was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this + Recognizer was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this + Recognizer will be purged. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this Recognizer + is in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the Recognizer is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the Recognizer is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + class State(proto.Enum): + r"""Set of states that define the lifecycle of a Recognizer. + + Values: + STATE_UNSPECIFIED (0): + The default value. This value is used if the + state is omitted. + ACTIVE (2): + The Recognizer is active and ready for use. + DELETED (4): + This Recognizer has been deleted. + """ + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + uid: str = proto.Field( + proto.STRING, + number=2, + ) + display_name: str = proto.Field( + proto.STRING, + number=3, + ) + model: str = proto.Field( + proto.STRING, + number=4, + ) + language_codes: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=17, + ) + default_recognition_config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=6, + message='RecognitionConfig', + ) + annotations: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=7, + ) + state: State = proto.Field( + proto.ENUM, + number=8, + enum=State, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=10, + message=timestamp_pb2.Timestamp, + ) + delete_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + expire_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=14, + message=timestamp_pb2.Timestamp, + ) + etag: str = proto.Field( + proto.STRING, + number=12, + ) + reconciling: bool = proto.Field( + proto.BOOL, + number=13, + ) + kms_key_name: str = proto.Field( + proto.STRING, + number=15, + ) + kms_key_version_name: str = proto.Field( + proto.STRING, + number=16, + ) + + +class AutoDetectDecodingConfig(proto.Message): + r"""Automatically detected decoding parameters. Supported for the + following encodings: + + - WAV_LINEAR16: 16-bit signed little-endian PCM samples in a WAV + container. + + - WAV_MULAW: 8-bit companded mulaw samples in a WAV container. + + - WAV_ALAW: 8-bit companded alaw samples in a WAV container. + + - RFC4867_5_AMR: AMR frames with an rfc4867.5 header. + + - RFC4867_5_AMRWB: AMR-WB frames with an rfc4867.5 header. + + - FLAC: FLAC frames in the "native FLAC" container format. + + - MP3: MPEG audio frames with optional (ignored) ID3 metadata. + + - OGG_OPUS: Opus audio frames in an Ogg container. + + - WEBM_OPUS: Opus audio frames in a WebM container. + + - M4A: M4A audio format. + + """ + + +class ExplicitDecodingConfig(proto.Message): + r"""Explicitly specified decoding parameters. + + Attributes: + encoding (google.cloud.speech_v2.types.ExplicitDecodingConfig.AudioEncoding): + Required. Encoding of the audio data sent for + recognition. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent for recognition. + Valid values are: 8000-48000. 16000 is optimal. For best + results, set the sampling rate of the audio source to 16000 + Hz. If that's not possible, use the native sample rate of + the audio source (instead of re-sampling). Supported for the + following encodings: + + - LINEAR16: Headerless 16-bit signed little-endian PCM + samples. + + - MULAW: Headerless 8-bit companded mulaw samples. + + - ALAW: Headerless 8-bit companded alaw samples. + audio_channel_count (int): + Number of channels present in the audio data sent for + recognition. Supported for the following encodings: + + - LINEAR16: Headerless 16-bit signed little-endian PCM + samples. + + - MULAW: Headerless 8-bit companded mulaw samples. + + - ALAW: Headerless 8-bit companded alaw samples. + + The maximum allowed value is 8. + """ + class AudioEncoding(proto.Enum): + r"""Supported audio data encodings. + + Values: + AUDIO_ENCODING_UNSPECIFIED (0): + Default value. This value is unused. + LINEAR16 (1): + Headerless 16-bit signed little-endian PCM + samples. + MULAW (2): + Headerless 8-bit companded mulaw samples. + ALAW (3): + Headerless 8-bit companded alaw samples. + """ + AUDIO_ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + MULAW = 2 + ALAW = 3 + + encoding: AudioEncoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz: int = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count: int = proto.Field( + proto.INT32, + number=3, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Configuration to enable speaker diarization. + + Attributes: + min_speaker_count (int): + Required. Minimum number of speakers in the conversation. + This range gives you more flexibility by allowing the system + to automatically determine the correct number of speakers. + + To fix the number of speakers detected in the audio, set + ``min_speaker_count`` = ``max_speaker_count``. + max_speaker_count (int): + Required. Maximum number of speakers in the conversation. + Valid values are: 1-6. Must be >= ``min_speaker_count``. + This range gives you more flexibility by allowing the system + to automatically determine the correct number of speakers. + """ + + min_speaker_count: int = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count: int = proto.Field( + proto.INT32, + number=3, + ) + + +class RecognitionFeatures(proto.Message): + r"""Available recognition features. + + Attributes: + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, for instance, "f***". If set + to ``false`` or omitted, profanities won't be filtered out. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_word_confidence (bool): + If ``true``, the top result includes a list of words and the + confidence for those words. If ``false``, no word-level + confidence information is returned. The default is + ``false``. + enable_automatic_punctuation (bool): + If ``true``, adds punctuation to recognition result + hypotheses. This feature is only available in select + languages. The default ``false`` value does not add + punctuation to result hypotheses. + enable_spoken_punctuation (bool): + The spoken punctuation behavior for the call. If ``true``, + replaces spoken punctuation with the corresponding symbols + in the request. For example, "how are you question mark" + becomes "how are you?". See + https://cloud.google.com/speech-to-text/docs/spoken-punctuation + for support. If ``false``, spoken punctuation is not + replaced. + enable_spoken_emojis (bool): + The spoken emoji behavior for the call. If ``true``, adds + spoken emoji formatting for the request. This will replace + spoken emojis with the corresponding Unicode symbols in the + final transcript. If ``false``, spoken emojis are not + replaced. + multi_channel_mode (google.cloud.speech_v2.types.RecognitionFeatures.MultiChannelMode): + Mode for recognizing multi-channel audio. + diarization_config (google.cloud.speech_v2.types.SpeakerDiarizationConfig): + Configuration to enable speaker diarization + and set additional parameters to make + diarization better suited for your application. + When this is enabled, we send all the words from + the beginning of the audio for the top + alternative in every consecutive STREAMING + responses. This is done in order to improve our + speaker tags as our models learn to identify the + speakers in the conversation over time. For + non-streaming requests, the diarization results + will be provided only in the top alternative of + the FINAL SpeechRecognitionResult. + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. The + server may return fewer than ``max_alternatives``. Valid + values are ``0``-``30``. A value of ``0`` or ``1`` will + return a maximum of one. If omitted, will return a maximum + of one. + """ + class MultiChannelMode(proto.Enum): + r"""Options for how to recognize multi-channel audio. + + Values: + MULTI_CHANNEL_MODE_UNSPECIFIED (0): + Default value for the multi-channel mode. If + the audio contains multiple channels, only the + first channel will be transcribed; other + channels will be ignored. + SEPARATE_RECOGNITION_PER_CHANNEL (1): + If selected, each channel in the provided audio is + transcribed independently. This cannot be selected if the + selected [model][google.cloud.speech.v2.Recognizer.model] is + ``latest_short``. + """ + MULTI_CHANNEL_MODE_UNSPECIFIED = 0 + SEPARATE_RECOGNITION_PER_CHANNEL = 1 + + profanity_filter: bool = proto.Field( + proto.BOOL, + number=1, + ) + enable_word_time_offsets: bool = proto.Field( + proto.BOOL, + number=2, + ) + enable_word_confidence: bool = proto.Field( + proto.BOOL, + number=3, + ) + enable_automatic_punctuation: bool = proto.Field( + proto.BOOL, + number=4, + ) + enable_spoken_punctuation: bool = proto.Field( + proto.BOOL, + number=14, + ) + enable_spoken_emojis: bool = proto.Field( + proto.BOOL, + number=15, + ) + multi_channel_mode: MultiChannelMode = proto.Field( + proto.ENUM, + number=17, + enum=MultiChannelMode, + ) + diarization_config: 'SpeakerDiarizationConfig' = proto.Field( + proto.MESSAGE, + number=9, + message='SpeakerDiarizationConfig', + ) + max_alternatives: int = proto.Field( + proto.INT32, + number=16, + ) + + +class TranscriptNormalization(proto.Message): + r"""Transcription normalization configuration. Use transcription + normalization to automatically replace parts of the transcript + with phrases of your choosing. For StreamingRecognize, this + normalization only applies to stable partial transcripts + (stability > 0.8) and final transcripts. + + Attributes: + entries (MutableSequence[google.cloud.speech_v2.types.TranscriptNormalization.Entry]): + A list of replacement entries. We will perform replacement + with one entry at a time. For example, the second entry in + ["cat" => "dog", "mountain cat" => "mountain dog"] will + never be applied because we will always process the first + entry before it. At most 100 entries. + """ + + class Entry(proto.Message): + r"""A single replacement configuration. + + Attributes: + search (str): + What to replace. Max length is 100 + characters. + replace (str): + What to replace with. Max length is 100 + characters. + case_sensitive (bool): + Whether the search is case sensitive. + """ + + search: str = proto.Field( + proto.STRING, + number=1, + ) + replace: str = proto.Field( + proto.STRING, + number=2, + ) + case_sensitive: bool = proto.Field( + proto.BOOL, + number=3, + ) + + entries: MutableSequence[Entry] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=Entry, + ) + + +class SpeechAdaptation(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. PhraseSets can be specified as + an inline resource, or a reference to an existing PhraseSet + resource. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v2.types.SpeechAdaptation.AdaptationPhraseSet]): + A list of inline or referenced PhraseSets. + custom_classes (MutableSequence[google.cloud.speech_v2.types.CustomClass]): + A list of inline CustomClasses. Existing + CustomClass resources can be referenced directly + in a PhraseSet. + """ + + class AdaptationPhraseSet(proto.Message): + r"""A biasing PhraseSet, which can be either a string referencing + the name of an existing PhraseSets resource, or an inline + definition of a PhraseSet. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + phrase_set (str): + The name of an existing PhraseSet resource. + The user must have read access to the resource + and it must not be deleted. + + This field is a member of `oneof`_ ``value``. + inline_phrase_set (google.cloud.speech_v2.types.PhraseSet): + An inline defined PhraseSet. + + This field is a member of `oneof`_ ``value``. + """ + + phrase_set: str = proto.Field( + proto.STRING, + number=1, + oneof='value', + ) + inline_phrase_set: 'PhraseSet' = proto.Field( + proto.MESSAGE, + number=2, + oneof='value', + message='PhraseSet', + ) + + phrase_sets: MutableSequence[AdaptationPhraseSet] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=AdaptationPhraseSet, + ) + custom_classes: MutableSequence['CustomClass'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='CustomClass', + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the Recognizer that specifies how to + process the recognition request. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + auto_decoding_config (google.cloud.speech_v2.types.AutoDetectDecodingConfig): + Automatically detect decoding parameters. + Preferred for supported formats. + + This field is a member of `oneof`_ ``decoding_config``. + explicit_decoding_config (google.cloud.speech_v2.types.ExplicitDecodingConfig): + Explicitly specified decoding parameters. + Required if using headerless PCM audio + (linear16, mulaw, alaw). + + This field is a member of `oneof`_ ``decoding_config``. + model (str): + Optional. Which model to use for recognition requests. + Select the model best suited to your domain to get best + results. + + Guidance for choosing which model to use can be found in the + `Transcription Models + Documentation `__ + and the models supported in each region can be found in the + `Table Of Supported + Models `__. + language_codes (MutableSequence[str]): + Optional. The language of the supplied audio as a + `BCP-47 `__ + language tag. Language tags are normalized to BCP-47 before + they are used eg "en-us" becomes "en-US". + + Supported languages for each model are listed in the `Table + of Supported + Models `__. + + If additional languages are provided, recognition result + will contain recognition in the most likely language + detected. The recognition result will include the language + tag of the language detected in the audio. + features (google.cloud.speech_v2.types.RecognitionFeatures): + Speech recognition features to enable. + adaptation (google.cloud.speech_v2.types.SpeechAdaptation): + Speech adaptation context that weights + recognizer predictions for specific words and + phrases. + transcript_normalization (google.cloud.speech_v2.types.TranscriptNormalization): + Optional. Use transcription normalization to + automatically replace parts of the transcript + with phrases of your choosing. For + StreamingRecognize, this normalization only + applies to stable partial transcripts (stability + > 0.8) and final transcripts. + """ + + auto_decoding_config: 'AutoDetectDecodingConfig' = proto.Field( + proto.MESSAGE, + number=7, + oneof='decoding_config', + message='AutoDetectDecodingConfig', + ) + explicit_decoding_config: 'ExplicitDecodingConfig' = proto.Field( + proto.MESSAGE, + number=8, + oneof='decoding_config', + message='ExplicitDecodingConfig', + ) + model: str = proto.Field( + proto.STRING, + number=9, + ) + language_codes: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=10, + ) + features: 'RecognitionFeatures' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionFeatures', + ) + adaptation: 'SpeechAdaptation' = proto.Field( + proto.MESSAGE, + number=6, + message='SpeechAdaptation', + ) + transcript_normalization: 'TranscriptNormalization' = proto.Field( + proto.MESSAGE, + number=11, + message='TranscriptNormalization', + ) + + +class RecognizeRequest(proto.Message): + r"""Request message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] method. Either + ``content`` or ``uri`` must be supplied. Supplying both or neither + returns [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See + `content + limits `__. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an empty + implicit Recognizer. + config (google.cloud.speech_v2.types.RecognitionConfig): + Features and audio metadata to use for the Automatic Speech + Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all non-default valued fields in + [config][google.cloud.speech.v2.RecognizeRequest.config] + override the values in the recognizer for this recognition + request. If a mask is provided, only the fields listed in + the mask override the config in the recognizer for this + recognition request. If a wildcard (``*``) is provided, + [config][google.cloud.speech.v2.RecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + content (bytes): + The audio data bytes encoded as specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + As with all bytes fields, proto buffers use a pure binary + representation, whereas JSON representations use base64. + + This field is a member of `oneof`_ ``audio_source``. + uri (str): + URI that points to a file that contains audio data bytes as + specified in + [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. + The file must not be compressed (for example, gzip). + Currently, only Google Cloud Storage URIs are supported, + which must be specified in the following format: + ``gs://bucket_name/object_name`` (other URI formats return + [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For + more information, see `Request + URIs `__. + + This field is a member of `oneof`_ ``audio_source``. + """ + + recognizer: str = proto.Field( + proto.STRING, + number=3, + ) + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + config_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=8, + message=field_mask_pb2.FieldMask, + ) + content: bytes = proto.Field( + proto.BYTES, + number=5, + oneof='audio_source', + ) + uri: str = proto.Field( + proto.STRING, + number=6, + oneof='audio_source', + ) + + +class RecognitionResponseMetadata(proto.Message): + r"""Metadata about the recognition request and response. + + Attributes: + total_billed_duration (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + """ + + total_billed_duration: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=6, + message=duration_pb2.Duration, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final] + is set to ``true``. This field is not guaranteed to be + accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (MutableSequence[google.cloud.speech_v2.types.WordInfo]): + A list of word-specific information for each recognized + word. When the + [SpeakerDiarizationConfig][google.cloud.speech.v2.SpeakerDiarizationConfig] + is set, you will see all the words from the beginning of the + audio. + """ + + transcript: str = proto.Field( + proto.STRING, + number=1, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=2, + ) + words: MutableSequence['WordInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='WordInfo', + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + + Attributes: + start_offset (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if + [enable_word_time_offsets][google.cloud.speech.v2.RecognitionFeatures.enable_word_time_offsets] + is ``true`` and only in the top hypothesis. This is an + experimental feature and the accuracy of the time offset can + vary. + end_offset (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if + [enable_word_time_offsets][google.cloud.speech.v2.RecognitionFeatures.enable_word_time_offsets] + is ``true`` and only in the top hypothesis. This is an + experimental feature and the accuracy of the time offset can + vary. + word (str): + The word corresponding to this set of + information. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final] + is set to ``true``. This field is not guaranteed to be + accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + speaker_label (str): + A distinct label is assigned for every speaker within the + audio. This field specifies which one of those speakers was + detected to have spoken this word. ``speaker_label`` is set + if + [SpeakerDiarizationConfig][google.cloud.speech.v2.SpeakerDiarizationConfig] + is given and only in the top alternative. + """ + + start_offset: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_offset: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word: str = proto.Field( + proto.STRING, + number=3, + ) + confidence: float = proto.Field( + proto.FLOAT, + number=4, + ) + speaker_label: str = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v2.types.SpeechRecognitionAlternative]): + May contain one or more recognition + hypotheses. These alternatives are ordered in + terms of accuracy, with the top (first) + alternative being the most probable, as ranked + by the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For ``audio_channel_count`` = ``N``, its + output values can range from ``1`` to ``N``. + result_end_offset (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + channel_tag: int = proto.Field( + proto.INT32, + number=2, + ) + result_end_offset: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + language_code: str = proto.Field( + proto.STRING, + number=5, + ) + + +class RecognizeResponse(proto.Message): + r"""Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] method. + + Attributes: + results (MutableSequence[google.cloud.speech_v2.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + Metadata about the recognition. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='SpeechRecognitionResult', + ) + metadata: 'RecognitionResponseMetadata' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionResponseMetadata', + ) + + +class StreamingRecognitionFeatures(proto.Message): + r"""Available recognition features specific to streaming + recognition requests. + + Attributes: + enable_voice_activity_events (bool): + If ``true``, responses with voice activity speech events + will be returned as they are detected. + interim_results (bool): + Whether or not to stream interim results to + the client. If set to true, interim results will + be streamed to the client. Otherwise, only the + final response will be streamed back. + voice_activity_timeout (google.cloud.speech_v2.types.StreamingRecognitionFeatures.VoiceActivityTimeout): + If set, the server will automatically close the stream after + the specified duration has elapsed after the last + VOICE_ACTIVITY speech event has been sent. The field + ``voice_activity_events`` must also be set to true. + """ + + class VoiceActivityTimeout(proto.Message): + r"""Events that a timeout can be set on for voice activity. + + Attributes: + speech_start_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream if no speech + begins. If this is set and no speech is detected + in this duration at the start of the stream, the + server will close the stream. + speech_end_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream after speech + ends. If this is set and no speech is detected + in this duration after speech was detected, the + server will close the stream. + """ + + speech_start_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + speech_end_timeout: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + enable_voice_activity_events: bool = proto.Field( + proto.BOOL, + number=1, + ) + interim_results: bool = proto.Field( + proto.BOOL, + number=2, + ) + voice_activity_timeout: VoiceActivityTimeout = proto.Field( + proto.MESSAGE, + number=3, + message=VoiceActivityTimeout, + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides configuration information for the StreamingRecognize + request. + + Attributes: + config (google.cloud.speech_v2.types.RecognitionConfig): + Required. Features and audio metadata to use for the + Automatic Speech Recognition. This field in combination with + the + [config_mask][google.cloud.speech.v2.StreamingRecognitionConfig.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.StreamingRecognitionConfig.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all non-default valued fields in + [config][google.cloud.speech.v2.StreamingRecognitionConfig.config] + override the values in the Recognizer for this recognition + request. If a mask is provided, only the fields listed in + the mask override the config in the Recognizer for this + recognition request. If a wildcard (``*``) is provided, + [config][google.cloud.speech.v2.StreamingRecognitionConfig.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + streaming_features (google.cloud.speech_v2.types.StreamingRecognitionFeatures): + Speech recognition features to enable + specific to streaming audio recognition + requests. + """ + + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + config_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + streaming_features: 'StreamingRecognitionFeatures' = proto.Field( + proto.MESSAGE, + number=2, + message='StreamingRecognitionFeatures', + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""Request message for the + [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] + method. Multiple + [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] + messages are sent in one call. + + If the [Recognizer][google.cloud.speech.v2.Recognizer] referenced by + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + contains a fully specified request configuration then the stream may + only contain messages with only + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] set. + + Otherwise the first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message that together fully specify the request configuration and + must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. All + subsequent messages must only have + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] set. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an empty + implicit Recognizer. + streaming_config (google.cloud.speech_v2.types.StreamingRecognitionConfig): + StreamingRecognitionConfig to be used in this + recognition attempt. If provided, it will + override the default RecognitionConfig stored in + the Recognizer. + + This field is a member of `oneof`_ ``streaming_request``. + audio (bytes): + Inline audio bytes to be Recognized. + Maximum size for this field is 15 KB per + request. + + This field is a member of `oneof`_ ``streaming_request``. + """ + + recognizer: str = proto.Field( + proto.STRING, + number=3, + ) + streaming_config: 'StreamingRecognitionConfig' = proto.Field( + proto.MESSAGE, + number=6, + oneof='streaming_request', + message='StreamingRecognitionConfig', + ) + audio: bytes = proto.Field( + proto.BYTES, + number=5, + oneof='streaming_request', + ) + + +class BatchRecognizeRequest(proto.Message): + r"""Request message for the + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + method. + + Attributes: + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + The {recognizer} segment may be set to ``_`` to use an empty + implicit Recognizer. + config (google.cloud.speech_v2.types.RecognitionConfig): + Features and audio metadata to use for the Automatic Speech + Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all given fields in + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + override the values in the recognizer for this recognition + request. If a mask is provided, only the fields listed in + the mask override the config in the recognizer for this + recognition request. If a wildcard (``*``) is provided, + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + files (MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]): + Audio files with file metadata for ASR. + The maximum number of files allowed to be + specified is 5. + recognition_output_config (google.cloud.speech_v2.types.RecognitionOutputConfig): + Configuration options for where to output the + transcripts of each file. + processing_strategy (google.cloud.speech_v2.types.BatchRecognizeRequest.ProcessingStrategy): + Processing strategy to use for this request. + """ + class ProcessingStrategy(proto.Enum): + r"""Possible processing strategies for batch requests. + + Values: + PROCESSING_STRATEGY_UNSPECIFIED (0): + Default value for the processing strategy. + The request is processed as soon as its + received. + DYNAMIC_BATCHING (1): + If selected, processes the request during + lower utilization periods for a price discount. + The request is fulfilled within 24 hours. + """ + PROCESSING_STRATEGY_UNSPECIFIED = 0 + DYNAMIC_BATCHING = 1 + + recognizer: str = proto.Field( + proto.STRING, + number=1, + ) + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=4, + message='RecognitionConfig', + ) + config_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=5, + message=field_mask_pb2.FieldMask, + ) + files: MutableSequence['BatchRecognizeFileMetadata'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='BatchRecognizeFileMetadata', + ) + recognition_output_config: 'RecognitionOutputConfig' = proto.Field( + proto.MESSAGE, + number=6, + message='RecognitionOutputConfig', + ) + processing_strategy: ProcessingStrategy = proto.Field( + proto.ENUM, + number=7, + enum=ProcessingStrategy, + ) + + +class GcsOutputConfig(proto.Message): + r"""Output configurations for Cloud Storage. + + Attributes: + uri (str): + The Cloud Storage URI prefix with which + recognition results will be written. + """ + + uri: str = proto.Field( + proto.STRING, + number=1, + ) + + +class InlineOutputConfig(proto.Message): + r"""Output configurations for inline response. + """ + + +class RecognitionOutputConfig(proto.Message): + r"""Configuration options for the output(s) of recognition. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + gcs_output_config (google.cloud.speech_v2.types.GcsOutputConfig): + If this message is populated, recognition + results are written to the provided Google Cloud + Storage URI. + + This field is a member of `oneof`_ ``output``. + inline_response_config (google.cloud.speech_v2.types.InlineOutputConfig): + If this message is populated, recognition results are + provided in the + [BatchRecognizeResponse][google.cloud.speech.v2.BatchRecognizeResponse] + message of the Operation when completed. This is only + supported when calling + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + with just one audio file. + + This field is a member of `oneof`_ ``output``. + """ + + gcs_output_config: 'GcsOutputConfig' = proto.Field( + proto.MESSAGE, + number=1, + oneof='output', + message='GcsOutputConfig', + ) + inline_response_config: 'InlineOutputConfig' = proto.Field( + proto.MESSAGE, + number=2, + oneof='output', + message='InlineOutputConfig', + ) + + +class BatchRecognizeResponse(proto.Message): + r"""Response message for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] that + is packaged into a longrunning + [Operation][google.longrunning.Operation]. + + Attributes: + results (MutableMapping[str, google.cloud.speech_v2.types.BatchRecognizeFileResult]): + Map from filename to the final result for + that file. + total_billed_duration (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + """ + + results: MutableMapping[str, 'BatchRecognizeFileResult'] = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=1, + message='BatchRecognizeFileResult', + ) + total_billed_duration: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + +class BatchRecognizeResults(proto.Message): + r"""Output type for Cloud Storage of BatchRecognize transcripts. + Though this proto isn't returned in this API anywhere, the Cloud + Storage transcripts will be this proto serialized and should be + parsed as such. + + Attributes: + results (MutableSequence[google.cloud.speech_v2.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + Metadata about the recognition. + """ + + results: MutableSequence['SpeechRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionResult', + ) + metadata: 'RecognitionResponseMetadata' = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionResponseMetadata', + ) + + +class CloudStorageResult(proto.Message): + r"""Final results written to Cloud Storage. + + Attributes: + uri (str): + The Cloud Storage URI to which recognition + results were written. + """ + + uri: str = proto.Field( + proto.STRING, + number=1, + ) + + +class InlineResult(proto.Message): + r"""Final results returned inline in the recognition response. + + Attributes: + transcript (google.cloud.speech_v2.types.BatchRecognizeResults): + The transcript for the audio file. + """ + + transcript: 'BatchRecognizeResults' = proto.Field( + proto.MESSAGE, + number=1, + message='BatchRecognizeResults', + ) + + +class BatchRecognizeFileResult(proto.Message): + r"""Final results for a single file. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + error (google.rpc.status_pb2.Status): + Error if one was encountered. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + + cloud_storage_result (google.cloud.speech_v2.types.CloudStorageResult): + Recognition results written to Cloud Storage. This is + populated only when + [GcsOutputConfig][google.cloud.speech.v2.GcsOutputConfig] is + set in the + [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig]. + + This field is a member of `oneof`_ ``result``. + inline_result (google.cloud.speech_v2.types.InlineResult): + Recognition results. This is populated only when + [InlineOutputConfig][google.cloud.speech.v2.InlineOutputConfig] + is set in the + [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig]. + + This field is a member of `oneof`_ ``result``. + uri (str): + Deprecated. Use ``cloud_storage_result.native_format_uri`` + instead. + transcript (google.cloud.speech_v2.types.BatchRecognizeResults): + Deprecated. Use ``inline_result.transcript`` instead. + """ + + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=2, + message=status_pb2.Status, + ) + metadata: 'RecognitionResponseMetadata' = proto.Field( + proto.MESSAGE, + number=3, + message='RecognitionResponseMetadata', + ) + cloud_storage_result: 'CloudStorageResult' = proto.Field( + proto.MESSAGE, + number=5, + oneof='result', + message='CloudStorageResult', + ) + inline_result: 'InlineResult' = proto.Field( + proto.MESSAGE, + number=6, + oneof='result', + message='InlineResult', + ) + uri: str = proto.Field( + proto.STRING, + number=1, + ) + transcript: 'BatchRecognizeResults' = proto.Field( + proto.MESSAGE, + number=4, + message='BatchRecognizeResults', + ) + + +class BatchRecognizeTranscriptionMetadata(proto.Message): + r"""Metadata about transcription for a single file (for example, + progress percent). + + Attributes: + progress_percent (int): + How much of the file has been transcribed so + far. + error (google.rpc.status_pb2.Status): + Error if one was encountered. + uri (str): + The Cloud Storage URI to which recognition + results will be written. + """ + + progress_percent: int = proto.Field( + proto.INT32, + number=1, + ) + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=2, + message=status_pb2.Status, + ) + uri: str = proto.Field( + proto.STRING, + number=3, + ) + + +class BatchRecognizeMetadata(proto.Message): + r"""Operation metadata for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize]. + + Attributes: + transcription_metadata (MutableMapping[str, google.cloud.speech_v2.types.BatchRecognizeTranscriptionMetadata]): + Map from provided filename to the + transcription metadata for that file. + """ + + transcription_metadata: MutableMapping[str, 'BatchRecognizeTranscriptionMetadata'] = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=1, + message='BatchRecognizeTranscriptionMetadata', + ) + + +class BatchRecognizeFileMetadata(proto.Message): + r"""Metadata about a single file in a batch for BatchRecognize. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + uri (str): + Cloud Storage URI for the audio file. + + This field is a member of `oneof`_ ``audio_source``. + config (google.cloud.speech_v2.types.RecognitionConfig): + Features and audio metadata to use for the Automatic Speech + Recognition. This field in combination with the + [config_mask][google.cloud.speech.v2.BatchRecognizeFileMetadata.config_mask] + field can be used to override parts of the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the Recognizer resource as well as the + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + at the request level. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] + that override the values in the + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] + of the recognizer during this recognition request. If no + mask is provided, all non-default valued fields in + [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] + override the values in the recognizer for this recognition + request. If a mask is provided, only the fields listed in + the mask override the config in the recognizer for this + recognition request. If a wildcard (``*``) is provided, + [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + """ + + uri: str = proto.Field( + proto.STRING, + number=1, + oneof='audio_source', + ) + config: 'RecognitionConfig' = proto.Field( + proto.MESSAGE, + number=4, + message='RecognitionConfig', + ) + config_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=5, + message=field_mask_pb2.FieldMask, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (MutableSequence[google.cloud.speech_v2.types.SpeechRecognitionAlternative]): + May contain one or more recognition + hypotheses. These alternatives are ordered in + terms of accuracy, with the top (first) + alternative being the most probable, as ranked + by the recognizer. + is_final (bool): + If ``false``, this + [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult] + represents an interim result that may change. If ``true``, + this is the final time the speech service will return this + particular + [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult], + the recognizer will not return any further hypotheses for + this portion of the transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + ([is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``false``). + The default of 0.0 is a sentinel value indicating + ``stability`` was not set. + result_end_offset (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For ``audio_channel_count`` = ``N``, its + output values can range from ``1`` to ``N``. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives: MutableSequence['SpeechRecognitionAlternative'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + is_final: bool = proto.Field( + proto.BOOL, + number=2, + ) + stability: float = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_offset: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag: int = proto.Field( + proto.INT32, + number=5, + ) + language_code: str = proto.Field( + proto.STRING, + number=6, + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``StreamingRecognizeResponse`` is the only message returned to the + client by ``StreamingRecognize``. A series of zero or more + ``StreamingRecognizeResponse`` messages are streamed back to the + client. If there is no recognizable audio then no messages are + streamed back to the client. + + Here are some examples of ``StreamingRecognizeResponse``\ s that + might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. results { alternatives { transcript: " that is the question" + confidence: 0.98 } alternatives { transcript: " that was the + question" } is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain final results; + they are indicated by ``is_final: true``. Concatenating these + together generates the full transcript: "to be or not to be that + is the question". + + - The others contain interim ``results``. #3 and #6 contain two + interim ``results``: the first portion has a high stability and + is less likely to change; the second portion has a low stability + and is very likely to change. A UI designer might choose to show + only high stability ``results``. + + - The specific ``stability`` and ``confidence`` values shown above + are only for illustrative purposes. Actual values may vary. + + - In each response, only one of these fields will be set: + ``error``, ``speech_event_type``, or one or more (repeated) + ``results``. + + Attributes: + results (MutableSequence[google.cloud.speech_v2.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``true`` + result (the newly settled portion), followed by zero or more + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``false`` + results (the interim results). + speech_event_type (google.cloud.speech_v2.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + speech_event_offset (google.protobuf.duration_pb2.Duration): + Time offset between the beginning of the + audio and event emission. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + Metadata about the recognition. + """ + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event. + + Values: + SPEECH_EVENT_TYPE_UNSPECIFIED (0): + No speech event specified. + END_OF_SINGLE_UTTERANCE (1): + This event indicates that the server has detected the end of + the user's speech utterance and expects no additional + speech. Therefore, the server will not process additional + audio and will close the gRPC bidirectional stream. This + event is only sent if there was a force cutoff due to + silence being detected early. This event is only available + through the ``latest_short`` + [model][google.cloud.speech.v2.Recognizer.model]. + SPEECH_ACTIVITY_BEGIN (2): + This event indicates that the server has detected the + beginning of human voice activity in the stream. This event + can be returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + SPEECH_ACTIVITY_END (3): + This event indicates that the server has detected the end of + human voice activity in the stream. This event can be + returned multiple times if speech starts and stops + repeatedly throughout the stream. This event is only sent if + ``voice_activity_events`` is set to true. + """ + SPEECH_EVENT_TYPE_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + SPEECH_ACTIVITY_BEGIN = 2 + SPEECH_ACTIVITY_END = 3 + + results: MutableSequence['StreamingRecognitionResult'] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='StreamingRecognitionResult', + ) + speech_event_type: SpeechEventType = proto.Field( + proto.ENUM, + number=3, + enum=SpeechEventType, + ) + speech_event_offset: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=7, + message=duration_pb2.Duration, + ) + metadata: 'RecognitionResponseMetadata' = proto.Field( + proto.MESSAGE, + number=5, + message='RecognitionResponseMetadata', + ) + + +class Config(proto.Message): + r"""Message representing the config for the Speech-to-Text API. This + includes an optional `KMS + key `__ + with which incoming data will be encrypted. + + Attributes: + name (str): + Output only. The name of the config resource. There is + exactly one config resource per project per location. The + expected format is + ``projects/{project}/locations/{location}/config``. + kms_key_name (str): + Optional. An optional `KMS key + name `__ + that if present, will be used to encrypt Speech-to-Text + resources at-rest. Updating this key will not encrypt + existing resources using this key; only new resources will + be encrypted using this key. The expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + kms_key_name: str = proto.Field( + proto.STRING, + number=2, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + + +class GetConfigRequest(proto.Message): + r"""Request message for the + [GetConfig][google.cloud.speech.v2.Speech.GetConfig] method. + + Attributes: + name (str): + Required. The name of the config to retrieve. There is + exactly one config resource per project per location. The + expected format is + ``projects/{project}/locations/{location}/config``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateConfigRequest(proto.Message): + r"""Request message for the + [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] method. + + Attributes: + config (google.cloud.speech_v2.types.Config): + Required. The config to update. + + The config's ``name`` field is used to identify the config + to be updated. The expected format is + ``projects/{project}/locations/{location}/config``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + config: 'Config' = proto.Field( + proto.MESSAGE, + number=1, + message='Config', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class CustomClass(proto.Message): + r"""CustomClass for biasing in speech recognition. Used to define + a set of words or phrases that represents a common concept or + theme likely to appear in your audio, for example a list of + passenger ship names. + + Attributes: + name (str): + Output only. The resource name of the CustomClass. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + uid (str): + Output only. System-assigned unique + identifier for the CustomClass. + display_name (str): + User-settable, human-readable name for the + CustomClass. Must be 63 characters or less. + items (MutableSequence[google.cloud.speech_v2.types.CustomClass.ClassItem]): + A collection of class items. + state (google.cloud.speech_v2.types.CustomClass.State): + Output only. The CustomClass lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + will be purged. + annotations (MutableMapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this CustomClass + is in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the CustomClass is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the CustomClass is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + class State(proto.Enum): + r"""Set of states that define the lifecycle of a CustomClass. + + Values: + STATE_UNSPECIFIED (0): + Unspecified state. This is only used/useful + for distinguishing unset values. + ACTIVE (2): + The normal and active state. + DELETED (4): + This CustomClass has been deleted. + """ + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + class ClassItem(proto.Message): + r"""An item of the class. + + Attributes: + value (str): + The class item's value. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + uid: str = proto.Field( + proto.STRING, + number=2, + ) + display_name: str = proto.Field( + proto.STRING, + number=4, + ) + items: MutableSequence[ClassItem] = proto.RepeatedField( + proto.MESSAGE, + number=5, + message=ClassItem, + ) + state: State = proto.Field( + proto.ENUM, + number=15, + enum=State, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + delete_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + expire_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + annotations: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=10, + ) + etag: str = proto.Field( + proto.STRING, + number=11, + ) + reconciling: bool = proto.Field( + proto.BOOL, + number=12, + ) + kms_key_name: str = proto.Field( + proto.STRING, + number=13, + ) + kms_key_version_name: str = proto.Field( + proto.STRING, + number=14, + ) + + +class PhraseSet(proto.Message): + r"""PhraseSet for biasing in speech recognition. A PhraseSet is + used to provide "hints" to the speech recognizer to favor + specific words and phrases in the results. + + Attributes: + name (str): + Output only. The resource name of the PhraseSet. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + uid (str): + Output only. System-assigned unique + identifier for the PhraseSet. + phrases (MutableSequence[google.cloud.speech_v2.types.PhraseSet.Phrase]): + A list of word and phrases. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Valid + ``boost`` values are between 0 (exclusive) and 20. We + recommend using a binary search approach to finding the + optimal value for your use case as well as adding phrases + both with and without boost to your requests. + display_name (str): + User-settable, human-readable name for the + PhraseSet. Must be 63 characters or less. + state (google.cloud.speech_v2.types.PhraseSet.State): + Output only. The PhraseSet lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + will be purged. + annotations (MutableMapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this PhraseSet is + in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the PhraseSet is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the PhraseSet is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + class State(proto.Enum): + r"""Set of states that define the lifecycle of a PhraseSet. + + Values: + STATE_UNSPECIFIED (0): + Unspecified state. This is only used/useful + for distinguishing unset values. + ACTIVE (2): + The normal and active state. + DELETED (4): + This PhraseSet has been deleted. + """ + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + class Phrase(proto.Message): + r"""A Phrase contains words and phrase "hints" so that the speech + recognition is more likely to recognize them. This can be used + to improve the accuracy for specific words and phrases, for + example, if specific commands are typically spoken by the user. + This can also be used to add additional words to the vocabulary + of the recognizer. + + List items can also include CustomClass references containing + groups of words that represent common concepts that occur in + natural language. + + Attributes: + value (str): + The phrase itself. + boost (float): + Hint Boost. Overrides the boost set at the + phrase set level. Positive value will increase + the probability that a specific phrase will be + recognized over other similar sounding phrases. + The higher the boost, the higher the chance of + false positive recognition as well. Negative + boost values would correspond to anti-biasing. + Anti-biasing is not enabled, so negative boost + values will return an error. Boost values must + be between 0 and 20. Any values outside that + range will return an error. We recommend using a + binary search approach to finding the optimal + value for your use case as well as adding + phrases both with and without boost to your + requests. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + boost: float = proto.Field( + proto.FLOAT, + number=2, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + uid: str = proto.Field( + proto.STRING, + number=2, + ) + phrases: MutableSequence[Phrase] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=Phrase, + ) + boost: float = proto.Field( + proto.FLOAT, + number=4, + ) + display_name: str = proto.Field( + proto.STRING, + number=5, + ) + state: State = proto.Field( + proto.ENUM, + number=15, + enum=State, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + delete_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + expire_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + annotations: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=10, + ) + etag: str = proto.Field( + proto.STRING, + number=11, + ) + reconciling: bool = proto.Field( + proto.BOOL, + number=12, + ) + kms_key_name: str = proto.Field( + proto.STRING, + number=13, + ) + kms_key_version_name: str = proto.Field( + proto.STRING, + number=14, + ) + + +class CreateCustomClassRequest(proto.Message): + r"""Request message for the + [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] + method. + + Attributes: + custom_class (google.cloud.speech_v2.types.CustomClass): + Required. The CustomClass to create. + validate_only (bool): + If set, validate the request and preview the + CustomClass, but do not actually create it. + custom_class_id (str): + The ID to use for the CustomClass, which will become the + final component of the CustomClass's resource name. + + This value should be 4-63 characters, and valid characters + are /[a-z][0-9]-/. + parent (str): + Required. The project and location where this CustomClass + will be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + custom_class: 'CustomClass' = proto.Field( + proto.MESSAGE, + number=1, + message='CustomClass', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + custom_class_id: str = proto.Field( + proto.STRING, + number=3, + ) + parent: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListCustomClassesRequest(proto.Message): + r"""Request message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Attributes: + parent (str): + Required. The project and location of CustomClass resources + to list. The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + Number of results per requests. A valid page_size ranges + from 0 to 100 inclusive. If the page_size is zero or + unspecified, a page size of 5 will be chosen. If the page + size exceeds 100, it will be coerced down to 100. Note that + a call might return fewer results than the requested page + size. + page_token (str): + A page token, received from a previous + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + show_deleted: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListCustomClassesResponse(proto.Message): + r"""Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Attributes: + custom_classes (MutableSequence[google.cloud.speech_v2.types.CustomClass]): + The list of requested CustomClasses. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListCustomClassesRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + custom_classes: MutableSequence['CustomClass'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='CustomClass', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetCustomClassRequest(proto.Message): + r"""Request message for the + [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to retrieve. The + expected format is + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateCustomClassRequest(proto.Message): + r"""Request message for the + [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] + method. + + Attributes: + custom_class (google.cloud.speech_v2.types.CustomClass): + Required. The CustomClass to update. + + The CustomClass's ``name`` field is used to identify the + CustomClass to update. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. If empty, + all fields are considered for update. + validate_only (bool): + If set, validate the request and preview the + updated CustomClass, but do not actually update + it. + """ + + custom_class: 'CustomClass' = proto.Field( + proto.MESSAGE, + number=1, + message='CustomClass', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeleteCustomClassRequest(proto.Message): + r"""Request message for the + [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to delete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + validate_only (bool): + If set, validate the request and preview the + deleted CustomClass, but do not actually delete + it. + allow_missing (bool): + If set to true, and the CustomClass is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing: bool = proto.Field( + proto.BOOL, + number=4, + ) + etag: str = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeleteCustomClassRequest(proto.Message): + r"""Request message for the + [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to undelete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + validate_only (bool): + If set, validate the request and preview the + undeleted CustomClass, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=3, + ) + etag: str = proto.Field( + proto.STRING, + number=4, + ) + + +class CreatePhraseSetRequest(proto.Message): + r"""Request message for the + [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] + method. + + Attributes: + phrase_set (google.cloud.speech_v2.types.PhraseSet): + Required. The PhraseSet to create. + validate_only (bool): + If set, validate the request and preview the + PhraseSet, but do not actually create it. + phrase_set_id (str): + The ID to use for the PhraseSet, which will become the final + component of the PhraseSet's resource name. + + This value should be 4-63 characters, and valid characters + are /[a-z][0-9]-/. + parent (str): + Required. The project and location where this PhraseSet will + be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + phrase_set: 'PhraseSet' = proto.Field( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + phrase_set_id: str = proto.Field( + proto.STRING, + number=3, + ) + parent: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListPhraseSetsRequest(proto.Message): + r"""Request message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Attributes: + parent (str): + Required. The project and location of PhraseSet resources to + list. The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + The maximum number of PhraseSets to return. + The service may return fewer than this value. If + unspecified, at most 5 PhraseSets will be + returned. The maximum value is 100; values above + 100 will be coerced to 100. + page_token (str): + A page token, received from a previous + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + show_deleted: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListPhraseSetsResponse(proto.Message): + r"""Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Attributes: + phrase_sets (MutableSequence[google.cloud.speech_v2.types.PhraseSet]): + The list of requested PhraseSets. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListPhraseSetsRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + phrase_sets: MutableSequence['PhraseSet'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetPhraseSetRequest(proto.Message): + r"""Request message for the + [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] method. + + Attributes: + name (str): + Required. The name of the PhraseSet to retrieve. The + expected format is + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdatePhraseSetRequest(proto.Message): + r"""Request message for the + [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] + method. + + Attributes: + phrase_set (google.cloud.speech_v2.types.PhraseSet): + Required. The PhraseSet to update. + + The PhraseSet's ``name`` field is used to identify the + PhraseSet to update. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to update. If empty, all non-default + valued fields are considered for update. Use ``*`` to update + the entire PhraseSet resource. + validate_only (bool): + If set, validate the request and preview the + updated PhraseSet, but do not actually update + it. + """ + + phrase_set: 'PhraseSet' = proto.Field( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeletePhraseSetRequest(proto.Message): + r"""Request message for the + [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] + method. + + Attributes: + name (str): + Required. The name of the PhraseSet to delete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + validate_only (bool): + If set, validate the request and preview the + deleted PhraseSet, but do not actually delete + it. + allow_missing (bool): + If set to true, and the PhraseSet is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing: bool = proto.Field( + proto.BOOL, + number=4, + ) + etag: str = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeletePhraseSetRequest(proto.Message): + r"""Request message for the + [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] + method. + + Attributes: + name (str): + Required. The name of the PhraseSet to undelete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + validate_only (bool): + If set, validate the request and preview the + undeleted PhraseSet, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=3, + ) + etag: str = proto.Field( + proto.STRING, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/mypy.ini b/owl-bot-staging/v2/mypy.ini new file mode 100644 index 00000000..574c5aed --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py new file mode 100644 index 00000000..65b6eeab --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/speech_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==7.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.speech.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.speech.v2.json new file mode 100644 index 00000000..73ac2fc1 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.speech.v2.json @@ -0,0 +1,3846 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.speech.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-speech", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.batch_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "BatchRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.BatchRecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "files", + "type": "MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "batch_recognize" + }, + "description": "Sample for BatchRecognize", + "file": "speech_v2_generated_speech_batch_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_BatchRecognize_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_batch_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.batch_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "BatchRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.BatchRecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "files", + "type": "MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "batch_recognize" + }, + "description": "Sample for BatchRecognize", + "file": "speech_v2_generated_speech_batch_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_BatchRecognize_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_batch_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v2_generated_speech_create_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v2_generated_speech_create_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v2_generated_speech_create_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreatePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v2_generated_speech_create_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreatePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateRecognizerRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "recognizer_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_recognizer" + }, + "description": "Sample for CreateRecognizer", + "file": "speech_v2_generated_speech_create_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateRecognizer_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateRecognizerRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "recognizer_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_recognizer" + }, + "description": "Sample for CreateRecognizer", + "file": "speech_v2_generated_speech_create_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateRecognizer_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v2_generated_speech_delete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v2_generated_speech_delete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v2_generated_speech_delete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeletePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v2_generated_speech_delete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeletePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_recognizer" + }, + "description": "Sample for DeleteRecognizer", + "file": "speech_v2_generated_speech_delete_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteRecognizer_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_recognizer" + }, + "description": "Sample for DeleteRecognizer", + "file": "speech_v2_generated_speech_delete_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteRecognizer_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "get_config" + }, + "description": "Sample for GetConfig", + "file": "speech_v2_generated_speech_get_config_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetConfig_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_config_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "get_config" + }, + "description": "Sample for GetConfig", + "file": "speech_v2_generated_speech_get_config_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetConfig_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_config_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v2_generated_speech_get_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetCustomClass_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v2_generated_speech_get_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetCustomClass_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v2_generated_speech_get_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetPhraseSet_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v2_generated_speech_get_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetPhraseSet_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Recognizer", + "shortName": "get_recognizer" + }, + "description": "Sample for GetRecognizer", + "file": "speech_v2_generated_speech_get_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetRecognizer_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Recognizer", + "shortName": "get_recognizer" + }, + "description": "Sample for GetRecognizer", + "file": "speech_v2_generated_speech_get_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetRecognizer_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v2_generated_speech_list_custom_classes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListCustomClasses_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_custom_classes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v2_generated_speech_list_custom_classes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListCustomClasses_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_custom_classes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_phrase_sets", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListPhraseSets" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListPhraseSetsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager", + "shortName": "list_phrase_sets" + }, + "description": "Sample for ListPhraseSets", + "file": "speech_v2_generated_speech_list_phrase_sets_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListPhraseSets_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_phrase_sets_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_phrase_sets", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListPhraseSets" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListPhraseSetsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager", + "shortName": "list_phrase_sets" + }, + "description": "Sample for ListPhraseSets", + "file": "speech_v2_generated_speech_list_phrase_sets_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListPhraseSets_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_phrase_sets_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_recognizers", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListRecognizers" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListRecognizersRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager", + "shortName": "list_recognizers" + }, + "description": "Sample for ListRecognizers", + "file": "speech_v2_generated_speech_list_recognizers_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListRecognizers_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_recognizers_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_recognizers", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListRecognizers" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListRecognizersRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager", + "shortName": "list_recognizers" + }, + "description": "Sample for ListRecognizers", + "file": "speech_v2_generated_speech_list_recognizers_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListRecognizers_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_recognizers_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.RecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "content", + "type": "bytes" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v2_generated_speech_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_Recognize_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.RecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "content", + "type": "bytes" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v2_generated_speech_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_Recognize_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v2_generated_speech_streaming_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_StreamingRecognize_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 55, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 58, + "start": 56, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 59, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_streaming_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v2_generated_speech_streaming_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_StreamingRecognize_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 55, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 58, + "start": 56, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 59, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_streaming_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_custom_class" + }, + "description": "Sample for UndeleteCustomClass", + "file": "speech_v2_generated_speech_undelete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_custom_class" + }, + "description": "Sample for UndeleteCustomClass", + "file": "speech_v2_generated_speech_undelete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_phrase_set" + }, + "description": "Sample for UndeletePhraseSet", + "file": "speech_v2_generated_speech_undelete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeletePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_phrase_set" + }, + "description": "Sample for UndeletePhraseSet", + "file": "speech_v2_generated_speech_undelete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeletePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_recognizer" + }, + "description": "Sample for UndeleteRecognizer", + "file": "speech_v2_generated_speech_undelete_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteRecognizer_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_recognizer" + }, + "description": "Sample for UndeleteRecognizer", + "file": "speech_v2_generated_speech_undelete_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteRecognizer_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateConfigRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.Config" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "update_config" + }, + "description": "Sample for UpdateConfig", + "file": "speech_v2_generated_speech_update_config_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateConfig_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_config_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateConfigRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.Config" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "update_config" + }, + "description": "Sample for UpdateConfig", + "file": "speech_v2_generated_speech_update_config_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateConfig_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_config_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v2_generated_speech_update_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateCustomClass_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v2_generated_speech_update_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateCustomClass_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v2_generated_speech_update_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdatePhraseSet_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v2_generated_speech_update_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdatePhraseSet_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateRecognizerRequest" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_recognizer" + }, + "description": "Sample for UpdateRecognizer", + "file": "speech_v2_generated_speech_update_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateRecognizer_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateRecognizerRequest" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_recognizer" + }, + "description": "Sample for UpdateRecognizer", + "file": "speech_v2_generated_speech_update_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateRecognizer_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_recognizer_sync.py" + } + ] +} diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py new file mode 100644 index 00000000..6afa1919 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for BatchRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_BatchRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_batch_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.BatchRecognizeRequest( + recognizer="recognizer_value", + ) + + # Make the request + operation = client.batch_recognize(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_BatchRecognize_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py new file mode 100644 index 00000000..4d20e073 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for BatchRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_BatchRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_batch_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.BatchRecognizeRequest( + recognizer="recognizer_value", + ) + + # Make the request + operation = client.batch_recognize(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_BatchRecognize_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py new file mode 100644 index 00000000..cfbaab8f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_create_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreateCustomClassRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreateCustomClass_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py new file mode 100644 index 00000000..8b3cd7d8 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_create_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreateCustomClassRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreateCustomClass_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py new file mode 100644 index 00000000..e2c732e2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_create_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreatePhraseSetRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreatePhraseSet_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py new file mode 100644 index 00000000..38e0e04a --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_create_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreatePhraseSetRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreatePhraseSet_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py new file mode 100644 index 00000000..29284616 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateRecognizer_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_create_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.CreateRecognizerRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreateRecognizer_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py new file mode 100644 index 00000000..b95ce987 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateRecognizer_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_create_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.CreateRecognizerRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_CreateRecognizer_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py new file mode 100644 index 00000000..a48b6e6e --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_delete_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeleteCustomClass_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py new file mode 100644 index 00000000..da94a2e1 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_delete_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeleteCustomClass_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py new file mode 100644 index 00000000..95b2e5be --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeletePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_delete_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeletePhraseSet_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py new file mode 100644 index 00000000..c94f4d5f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeletePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_delete_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeletePhraseSet_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py new file mode 100644 index 00000000..3d982cc2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteRecognizer_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_delete_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.DeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeleteRecognizer_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py new file mode 100644 index 00000000..98e7631c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteRecognizer_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_delete_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.DeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_DeleteRecognizer_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_async.py new file mode 100644 index 00000000..b9ce23e5 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetConfig_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_get_config(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetConfigRequest( + name="name_value", + ) + + # Make the request + response = await client.get_config(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetConfig_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py new file mode 100644 index 00000000..302ece0a --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetConfig_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_get_config(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetConfigRequest( + name="name_value", + ) + + # Make the request + response = client.get_config(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetConfig_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py new file mode 100644 index 00000000..9ca59b94 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_get_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = await client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetCustomClass_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py new file mode 100644 index 00000000..bbbea080 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_get_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetCustomClassRequest( + name="name_value", + ) + + # Make the request + response = client.get_custom_class(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetCustomClass_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py new file mode 100644 index 00000000..b8884195 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetPhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_get_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = await client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetPhraseSet_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py new file mode 100644 index 00000000..88ea7737 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetPhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_get_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetPhraseSetRequest( + name="name_value", + ) + + # Make the request + response = client.get_phrase_set(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetPhraseSet_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py new file mode 100644 index 00000000..53be7001 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetRecognizer_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_get_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.GetRecognizerRequest( + name="name_value", + ) + + # Make the request + response = await client.get_recognizer(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetRecognizer_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py new file mode 100644 index 00000000..ba4dc15b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetRecognizer_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_get_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.GetRecognizerRequest( + name="name_value", + ) + + # Make the request + response = client.get_recognizer(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_GetRecognizer_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py new file mode 100644 index 00000000..9a18b863 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListCustomClasses_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_list_custom_classes(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListCustomClasses_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py new file mode 100644 index 00000000..27ef733b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListCustomClasses_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_list_custom_classes(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListCustomClassesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_custom_classes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListCustomClasses_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py new file mode 100644 index 00000000..7b7bdb4f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSets +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListPhraseSets_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_list_phrase_sets(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListPhraseSetsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_sets(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListPhraseSets_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py new file mode 100644 index 00000000..12728ae2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSets +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListPhraseSets_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_list_phrase_sets(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListPhraseSetsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_phrase_sets(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListPhraseSets_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py new file mode 100644 index 00000000..cca485ec --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRecognizers +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListRecognizers_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_list_recognizers(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.ListRecognizersRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_recognizers(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListRecognizers_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py new file mode 100644 index 00000000..55f33a52 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRecognizers +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListRecognizers_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_list_recognizers(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.ListRecognizersRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_recognizers(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END speech_v2_generated_Speech_ListRecognizers_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_async.py new file mode 100644 index 00000000..208138d3 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_Recognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.RecognizeRequest( + content=b'content_blob', + recognizer="recognizer_value", + ) + + # Make the request + response = await client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_Recognize_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py new file mode 100644 index 00000000..a3ecf8d0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_Recognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.RecognizeRequest( + content=b'content_blob', + recognizer="recognizer_value", + ) + + # Make the request + response = client.recognize(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_Recognize_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py new file mode 100644 index 00000000..f81d1a4b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_StreamingRecognize_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_streaming_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.StreamingRecognizeRequest( + recognizer="recognizer_value", + ) + + # This method expects an iterator which contains + # 'speech_v2.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = await client.streaming_recognize(requests=request_generator()) + + # Handle the response + async for response in stream: + print(response) + +# [END speech_v2_generated_Speech_StreamingRecognize_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py new file mode 100644 index 00000000..8489797c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_StreamingRecognize_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_streaming_recognize(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.StreamingRecognizeRequest( + recognizer="recognizer_value", + ) + + # This method expects an iterator which contains + # 'speech_v2.StreamingRecognizeRequest' objects + # Here we create a generator that yields a single `request` for + # demonstrative purposes. + requests = [request] + + def request_generator(): + for request in requests: + yield request + + # Make the request + stream = client.streaming_recognize(requests=request_generator()) + + # Handle the response + for response in stream: + print(response) + +# [END speech_v2_generated_Speech_StreamingRecognize_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py new file mode 100644 index 00000000..a896dae9 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_undelete_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeleteCustomClass_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py new file mode 100644 index 00000000..c3c0a324 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_undelete_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteCustomClassRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeleteCustomClass_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py new file mode 100644 index 00000000..73f9b5ef --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeletePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_undelete_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeletePhraseSet_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py new file mode 100644 index 00000000..38d553b3 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeletePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_undelete_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeletePhraseSetRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeletePhraseSet_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py new file mode 100644 index 00000000..243c19e5 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteRecognizer_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_undelete_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeleteRecognizer_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py new file mode 100644 index 00000000..5b51257b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteRecognizer_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_undelete_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UndeleteRecognizerRequest( + name="name_value", + ) + + # Make the request + operation = client.undelete_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UndeleteRecognizer_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_async.py new file mode 100644 index 00000000..a76755ac --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateConfig_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_update_config(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateConfigRequest( + ) + + # Make the request + response = await client.update_config(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateConfig_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py new file mode 100644 index 00000000..a9de0872 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateConfig_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_update_config(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateConfigRequest( + ) + + # Make the request + response = client.update_config(request=request) + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateConfig_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py new file mode 100644 index 00000000..9004983e --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateCustomClass_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_update_custom_class(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateCustomClassRequest( + ) + + # Make the request + operation = client.update_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateCustomClass_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py new file mode 100644 index 00000000..9f51b8cf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateCustomClass_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_update_custom_class(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateCustomClassRequest( + ) + + # Make the request + operation = client.update_custom_class(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateCustomClass_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py new file mode 100644 index 00000000..8e224511 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdatePhraseSet_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_update_phrase_set(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdatePhraseSetRequest( + ) + + # Make the request + operation = client.update_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdatePhraseSet_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py new file mode 100644 index 00000000..7e3f2024 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdatePhraseSet_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_update_phrase_set(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdatePhraseSetRequest( + ) + + # Make the request + operation = client.update_phrase_set(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdatePhraseSet_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py new file mode 100644 index 00000000..73d58608 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateRecognizer_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +async def sample_update_recognizer(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # Initialize request argument(s) + request = speech_v2.UpdateRecognizerRequest( + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateRecognizer_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py new file mode 100644 index 00000000..1e976289 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateRecognizer_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import speech_v2 + + +def sample_update_recognizer(): + # Create a client + client = speech_v2.SpeechClient() + + # Initialize request argument(s) + request = speech_v2.UpdateRecognizerRequest( + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateRecognizer_sync] diff --git a/owl-bot-staging/v2/scripts/fixup_speech_v2_keywords.py b/owl-bot-staging/v2/scripts/fixup_speech_v2_keywords.py new file mode 100644 index 00000000..db10b58f --- /dev/null +++ b/owl-bot-staging/v2/scripts/fixup_speech_v2_keywords.py @@ -0,0 +1,198 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'batch_recognize': ('recognizer', 'config', 'config_mask', 'files', 'recognition_output_config', 'processing_strategy', ), + 'create_custom_class': ('custom_class', 'parent', 'validate_only', 'custom_class_id', ), + 'create_phrase_set': ('phrase_set', 'parent', 'validate_only', 'phrase_set_id', ), + 'create_recognizer': ('recognizer', 'parent', 'validate_only', 'recognizer_id', ), + 'delete_custom_class': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'delete_phrase_set': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'delete_recognizer': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'get_config': ('name', ), + 'get_custom_class': ('name', ), + 'get_phrase_set': ('name', ), + 'get_recognizer': ('name', ), + 'list_custom_classes': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'list_phrase_sets': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'list_recognizers': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'recognize': ('recognizer', 'config', 'config_mask', 'content', 'uri', ), + 'streaming_recognize': ('recognizer', 'streaming_config', 'audio', ), + 'undelete_custom_class': ('name', 'validate_only', 'etag', ), + 'undelete_phrase_set': ('name', 'validate_only', 'etag', ), + 'undelete_recognizer': ('name', 'validate_only', 'etag', ), + 'update_config': ('config', 'update_mask', ), + 'update_custom_class': ('custom_class', 'update_mask', 'validate_only', ), + 'update_phrase_set': ('phrase_set', 'update_mask', 'validate_only', ), + 'update_recognizer': ('recognizer', 'update_mask', 'validate_only', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=speechCallTransformer(), +): + """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 speech 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/v2/setup.py b/owl-bot-staging/v2/setup.py new file mode 100644 index 00000000..06fd97f9 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-speech' + + +description = "Google Cloud Speech API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/speech/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-speech" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 00000000..6c44adfe --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 00000000..ed7f9aed --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v2/tests/unit/__init__.py b/owl-bot-staging/v2/tests/unit/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v2/tests/unit/gapic/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v2/tests/unit/gapic/speech_v2/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/speech_v2/__init__.py new file mode 100644 index 00000000..1b4db446 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/speech_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v2/tests/unit/gapic/speech_v2/test_speech.py b/owl-bot-staging/v2/tests/unit/gapic/speech_v2/test_speech.py new file mode 100644 index 00000000..0612f157 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/speech_v2/test_speech.py @@ -0,0 +1,14339 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.location import locations_pb2 +from google.cloud.speech_v2.services.speech import SpeechAsyncClient +from google.cloud.speech_v2.services.speech import SpeechClient +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.services.speech import transports +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.SpeechGrpcTransport, "grpc"), + (transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + (SpeechClient, "rest"), +]) +def test_speech_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://speech.googleapis.com' + ) + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + transports.SpeechRestTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_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(SpeechClient, '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(SpeechClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (SpeechClient, transports.SpeechRestTransport, "rest", "true"), + (SpeechClient, transports.SpeechRestTransport, "rest", "false"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, SpeechAsyncClient +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + (SpeechClient, transports.SpeechRestTransport, "rest"), +]) +def test_speech_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (SpeechClient, transports.SpeechRestTransport, "rest", None), +]) +def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_speech_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v2.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_speech_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreateRecognizerRequest, + dict, +]) +def test_create_recognizer(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_recognizer_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 = SpeechClient( + 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_recognizer), + '__call__') as call: + client.create_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + +@pytest.mark.asyncio +async def test_create_recognizer_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.CreateRecognizerRequest): + client = SpeechAsyncClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_recognizer_async_from_dict(): + await test_create_recognizer_async(request_type=dict) + + +def test_create_recognizer_field_headers(): + client = SpeechClient( + 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 = cloud_speech.CreateRecognizerRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_recognizer(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_recognizer_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.CreateRecognizerRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_recognizer(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_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_recognizer( + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name='name_value') + assert arg == mock_val + arg = args[0].recognizer_id + mock_val = 'recognizer_id_value' + assert arg == mock_val + + +def test_create_recognizer_flattened_error(): + client = SpeechClient( + 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_recognizer( + cloud_speech.CreateRecognizerRequest(), + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + +@pytest.mark.asyncio +async def test_create_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_recognizer( + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name='name_value') + assert arg == mock_val + arg = args[0].recognizer_id + mock_val = 'recognizer_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + 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_recognizer( + cloud_speech.CreateRecognizerRequest(), + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListRecognizersRequest, + dict, +]) +def test_list_recognizers(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse( + next_page_token='next_page_token_value', + ) + response = client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecognizersPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_recognizers_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + client.list_recognizers() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + +@pytest.mark.asyncio +async def test_list_recognizers_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.ListRecognizersRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListRecognizersResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecognizersAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_recognizers_async_from_dict(): + await test_list_recognizers_async(request_type=dict) + + +def test_list_recognizers_field_headers(): + client = SpeechClient( + 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 = cloud_speech.ListRecognizersRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + call.return_value = cloud_speech.ListRecognizersResponse() + client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_recognizers_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.ListRecognizersRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListRecognizersResponse()) + await client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_recognizers_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_recognizers( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_recognizers_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_recognizers( + cloud_speech.ListRecognizersRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_recognizers_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListRecognizersResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_recognizers( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_recognizers_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_recognizers( + cloud_speech.ListRecognizersRequest(), + parent='parent_value', + ) + + +def test_list_recognizers_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token='abc', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token='def', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token='ghi', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_recognizers(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.Recognizer) + for i in results) +def test_list_recognizers_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token='abc', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token='def', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token='ghi', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + pages = list(client.list_recognizers(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_recognizers_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token='abc', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token='def', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token='ghi', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_recognizers(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.Recognizer) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_recognizers_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token='abc', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token='def', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token='ghi', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_recognizers(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetRecognizerRequest, + dict, +]) +def test_get_recognizer(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer( + name='name_value', + uid='uid_value', + display_name='display_name_value', + model='model_value', + language_codes=['language_codes_value'], + state=cloud_speech.Recognizer.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + response = client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Recognizer) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.model == 'model_value' + assert response.language_codes == ['language_codes_value'] + assert response.state == cloud_speech.Recognizer.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_recognizer_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 = SpeechClient( + 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_recognizer), + '__call__') as call: + client.get_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + +@pytest.mark.asyncio +async def test_get_recognizer_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.GetRecognizerRequest): + client = SpeechAsyncClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Recognizer( + name='name_value', + uid='uid_value', + display_name='display_name_value', + model='model_value', + language_codes=['language_codes_value'], + state=cloud_speech.Recognizer.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + )) + response = await client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Recognizer) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.model == 'model_value' + assert response.language_codes == ['language_codes_value'] + assert response.state == cloud_speech.Recognizer.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +@pytest.mark.asyncio +async def test_get_recognizer_async_from_dict(): + await test_get_recognizer_async(request_type=dict) + + +def test_get_recognizer_field_headers(): + client = SpeechClient( + 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 = cloud_speech.GetRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recognizer), + '__call__') as call: + call.return_value = cloud_speech.Recognizer() + client.get_recognizer(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_recognizer_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.GetRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recognizer), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Recognizer()) + await client.get_recognizer(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_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_recognizer_flattened_error(): + client = SpeechClient( + 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_recognizer( + cloud_speech.GetRecognizerRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Recognizer()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + 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_recognizer( + cloud_speech.GetRecognizerRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateRecognizerRequest, + dict, +]) +def test_update_recognizer(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_recognizer_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 = SpeechClient( + 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_recognizer), + '__call__') as call: + client.update_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + +@pytest.mark.asyncio +async def test_update_recognizer_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UpdateRecognizerRequest): + client = SpeechAsyncClient( + 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_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_recognizer_async_from_dict(): + await test_update_recognizer_async(request_type=dict) + + +def test_update_recognizer_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UpdateRecognizerRequest() + + request.recognizer.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_recognizer(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', + 'recognizer.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_recognizer_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UpdateRecognizerRequest() + + request.recognizer.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_recognizer(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', + 'recognizer.name=name_value', + ) in kw['metadata'] + + +def test_update_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_recognizer( + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_recognizer_flattened_error(): + client = SpeechClient( + 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_recognizer( + cloud_speech.UpdateRecognizerRequest(), + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_recognizer( + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + 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_recognizer( + cloud_speech.UpdateRecognizerRequest(), + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeleteRecognizerRequest, + dict, +]) +def test_delete_recognizer(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_recognizer_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + client.delete_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + +@pytest.mark.asyncio +async def test_delete_recognizer_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.DeleteRecognizerRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_recognizer_async_from_dict(): + await test_delete_recognizer_async(request_type=dict) + + +def test_delete_recognizer_field_headers(): + client = SpeechClient( + 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 = cloud_speech.DeleteRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_recognizer_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.DeleteRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_recognizer( + cloud_speech.DeleteRecognizerRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_recognizer( + cloud_speech.DeleteRecognizerRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeleteRecognizerRequest, + dict, +]) +def test_undelete_recognizer(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.undelete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_recognizer_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 = SpeechClient( + 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.undelete_recognizer), + '__call__') as call: + client.undelete_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + +@pytest.mark.asyncio +async def test_undelete_recognizer_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UndeleteRecognizerRequest): + client = SpeechAsyncClient( + 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.undelete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_recognizer_async_from_dict(): + await test_undelete_recognizer_async(request_type=dict) + + +def test_undelete_recognizer_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UndeleteRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.undelete_recognizer(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_undelete_recognizer_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UndeleteRecognizerRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.undelete_recognizer(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_undelete_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_undelete_recognizer_flattened_error(): + client = SpeechClient( + 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.undelete_recognizer( + cloud_speech.UndeleteRecognizerRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_undelete_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_recognizer( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_undelete_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + 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.undelete_recognizer( + cloud_speech.UndeleteRecognizerRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse( + ) + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +def test_recognize_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 = SpeechClient( + 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.recognize), + '__call__') as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + +@pytest.mark.asyncio +async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): + client = SpeechAsyncClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( + )) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_field_headers(): + client = SpeechClient( + 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 = cloud_speech.RecognizeRequest() + + request.recognizer = 'recognizer_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + call.return_value = cloud_speech.RecognizeResponse() + client.recognize(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', + 'recognizer=recognizer_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_recognize_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.RecognizeRequest() + + request.recognizer = 'recognizer_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + await client.recognize(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', + 'recognizer=recognizer_value', + ) in kw['metadata'] + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + content=b'content_blob', + uri='uri_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = 'recognizer_value' + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + assert args[0].uri == 'uri_value' + + +def test_recognize_flattened_error(): + client = SpeechClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + content=b'content_blob', + uri='uri_value', + ) + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + content=b'content_blob', + uri='uri_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = 'recognizer_value' + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + assert args[0].uri == 'uri_value' + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + content=b'content_blob', + uri='uri_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.StreamingRecognizeRequest, + dict, +]) +def test_streaming_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechAsyncClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.BatchRecognizeRequest, + dict, +]) +def test_batch_recognize(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.batch_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_batch_recognize_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 = SpeechClient( + 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.batch_recognize), + '__call__') as call: + client.batch_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + +@pytest.mark.asyncio +async def test_batch_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.BatchRecognizeRequest): + client = SpeechAsyncClient( + 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.batch_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_batch_recognize_async_from_dict(): + await test_batch_recognize_async(request_type=dict) + + +def test_batch_recognize_field_headers(): + client = SpeechClient( + 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 = cloud_speech.BatchRecognizeRequest() + + request.recognizer = 'recognizer_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.batch_recognize), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.batch_recognize(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', + 'recognizer=recognizer_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_batch_recognize_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.BatchRecognizeRequest() + + request.recognizer = 'recognizer_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.batch_recognize), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.batch_recognize(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', + 'recognizer=recognizer_value', + ) in kw['metadata'] + + +def test_batch_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.batch_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.batch_recognize( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = 'recognizer_value' + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + arg = args[0].files + mock_val = [cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')] + assert arg == mock_val + + +def test_batch_recognize_flattened_error(): + client = SpeechClient( + 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.batch_recognize( + cloud_speech.BatchRecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + +@pytest.mark.asyncio +async def test_batch_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.batch_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.batch_recognize( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = 'recognizer_value' + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + arg = args[0].files + mock_val = [cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')] + assert arg == mock_val + +@pytest.mark.asyncio +async def test_batch_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.batch_recognize( + cloud_speech.BatchRecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetConfigRequest, + dict, +]) +def test_get_config(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + ) + response = client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +def test_get_config_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + 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_config), + '__call__') as call: + client.get_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + +@pytest.mark.asyncio +async def test_get_config_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.GetConfigRequest): + client = SpeechAsyncClient( + 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_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + )) + response = await client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +@pytest.mark.asyncio +async def test_get_config_async_from_dict(): + await test_get_config_async(request_type=dict) + + +def test_get_config_field_headers(): + client = SpeechClient( + 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 = cloud_speech.GetConfigRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_config), + '__call__') as call: + call.return_value = cloud_speech.Config() + client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_config_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.GetConfigRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + await client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_config_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_config_flattened_error(): + client = SpeechClient( + 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_config( + cloud_speech.GetConfigRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_config_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_config_flattened_error_async(): + client = SpeechAsyncClient( + 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_config( + cloud_speech.GetConfigRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateConfigRequest, + dict, +]) +def test_update_config(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + ) + response = client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +def test_update_config_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + 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_config), + '__call__') as call: + client.update_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + +@pytest.mark.asyncio +async def test_update_config_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UpdateConfigRequest): + client = SpeechAsyncClient( + 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_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + )) + response = await client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +@pytest.mark.asyncio +async def test_update_config_async_from_dict(): + await test_update_config_async(request_type=dict) + + +def test_update_config_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UpdateConfigRequest() + + request.config.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_config), + '__call__') as call: + call.return_value = cloud_speech.Config() + client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'config.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_config_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UpdateConfigRequest() + + request.config.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + await client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'config.name=name_value', + ) in kw['metadata'] + + +def test_update_config_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_config( + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.Config(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_config_flattened_error(): + client = SpeechClient( + 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_config( + cloud_speech.UpdateConfigRequest(), + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_config_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_config( + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.Config(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_config_flattened_error_async(): + client = SpeechAsyncClient( + 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_config( + cloud_speech.UpdateConfigRequest(), + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_custom_class_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 = SpeechClient( + 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_custom_class), + '__call__') as call: + client.create_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + +@pytest.mark.asyncio +async def test_create_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.CreateCustomClassRequest): + client = SpeechAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_custom_class_async_from_dict(): + await test_create_custom_class_async(request_type=dict) + + +def test_create_custom_class_field_headers(): + client = SpeechClient( + 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 = cloud_speech.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_custom_class(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_custom_class_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.CreateCustomClassRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_custom_class(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_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_custom_class( + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + + +def test_create_custom_class_flattened_error(): + client = SpeechClient( + 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_custom_class( + cloud_speech.CreateCustomClassRequest(), + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_custom_class( + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = 'custom_class_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + 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_custom_class( + cloud_speech.CreateCustomClassRequest(), + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + response = client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + client.list_custom_classes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + +@pytest.mark.asyncio +async def test_list_custom_classes_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.ListCustomClassesRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListCustomClassesResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_from_dict(): + await test_list_custom_classes_async(request_type=dict) + + +def test_list_custom_classes_field_headers(): + client = SpeechClient( + 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 = cloud_speech.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = cloud_speech.ListCustomClassesResponse() + client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_custom_classes_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.ListCustomClassesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListCustomClassesResponse()) + await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_custom_classes_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_custom_classes_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech.ListCustomClassesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListCustomClassesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_custom_classes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_custom_classes( + cloud_speech.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_custom_classes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.CustomClass) + for i in results) +def test_list_custom_classes_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + pages = list(client.list_custom_classes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_custom_classes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.CustomClass) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_custom_classes(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetCustomClassRequest, + dict, +]) +def test_get_custom_class(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass( + name='name_value', + uid='uid_value', + display_name='display_name_value', + state=cloud_speech.CustomClass.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + response = client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.CustomClass) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.CustomClass.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_custom_class_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 = SpeechClient( + 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_custom_class), + '__call__') as call: + client.get_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + +@pytest.mark.asyncio +async def test_get_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.GetCustomClassRequest): + client = SpeechAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.CustomClass( + name='name_value', + uid='uid_value', + display_name='display_name_value', + state=cloud_speech.CustomClass.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + )) + response = await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.CustomClass) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.CustomClass.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +@pytest.mark.asyncio +async def test_get_custom_class_async_from_dict(): + await test_get_custom_class_async(request_type=dict) + + +def test_get_custom_class_field_headers(): + client = SpeechClient( + 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 = cloud_speech.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = cloud_speech.CustomClass() + client.get_custom_class(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_custom_class_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.GetCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.CustomClass()) + await client.get_custom_class(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_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_custom_class_flattened_error(): + client = SpeechClient( + 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_custom_class( + cloud_speech.GetCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + 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_custom_class( + cloud_speech.GetCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_custom_class_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 = SpeechClient( + 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_custom_class), + '__call__') as call: + client.update_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + +@pytest.mark.asyncio +async def test_update_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UpdateCustomClassRequest): + client = SpeechAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_custom_class_async_from_dict(): + await test_update_custom_class_async(request_type=dict) + + +def test_update_custom_class_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_custom_class_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UpdateCustomClassRequest() + + request.custom_class.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_custom_class(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', + 'custom_class.name=name_value', + ) in kw['metadata'] + + +def test_update_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_custom_class( + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_custom_class_flattened_error(): + client = SpeechClient( + 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_custom_class( + cloud_speech.UpdateCustomClassRequest(), + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_custom_class( + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + 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_custom_class( + cloud_speech.UpdateCustomClassRequest(), + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_custom_class_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + client.delete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + +@pytest.mark.asyncio +async def test_delete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.DeleteCustomClassRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_custom_class_async_from_dict(): + await test_delete_custom_class_async(request_type=dict) + + +def test_delete_custom_class_field_headers(): + client = SpeechClient( + 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 = cloud_speech.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_custom_class_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.DeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech.DeleteCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_custom_class( + cloud_speech.DeleteCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeleteCustomClassRequest, + dict, +]) +def test_undelete_custom_class(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.undelete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_custom_class_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 = SpeechClient( + 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.undelete_custom_class), + '__call__') as call: + client.undelete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + +@pytest.mark.asyncio +async def test_undelete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UndeleteCustomClassRequest): + client = SpeechAsyncClient( + 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.undelete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_custom_class_async_from_dict(): + await test_undelete_custom_class_async(request_type=dict) + + +def test_undelete_custom_class_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UndeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.undelete_custom_class(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_undelete_custom_class_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UndeleteCustomClassRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.undelete_custom_class(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_undelete_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_undelete_custom_class_flattened_error(): + client = SpeechClient( + 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.undelete_custom_class( + cloud_speech.UndeleteCustomClassRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_undelete_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_custom_class( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_undelete_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + 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.undelete_custom_class( + cloud_speech.UndeleteCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_phrase_set_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 = SpeechClient( + 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_phrase_set), + '__call__') as call: + client.create_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_create_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.CreatePhraseSetRequest): + client = SpeechAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_phrase_set_async_from_dict(): + await test_create_phrase_set_async(request_type=dict) + + +def test_create_phrase_set_field_headers(): + client = SpeechClient( + 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 = cloud_speech.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_phrase_set(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_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.CreatePhraseSetRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_phrase_set(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_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_phrase_set( + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + + +def test_create_phrase_set_flattened_error(): + client = SpeechClient( + 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_phrase_set( + cloud_speech.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_phrase_set( + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = 'phrase_set_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + 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_phrase_set( + cloud_speech.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListPhraseSetsRequest, + dict, +]) +def test_list_phrase_sets(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_sets_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + client.list_phrase_sets() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + +@pytest.mark.asyncio +async def test_list_phrase_sets_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.ListPhraseSetsRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListPhraseSetsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_from_dict(): + await test_list_phrase_sets_async(request_type=dict) + + +def test_list_phrase_sets_field_headers(): + client = SpeechClient( + 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 = cloud_speech.ListPhraseSetsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + call.return_value = cloud_speech.ListPhraseSetsResponse() + client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_phrase_sets_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.ListPhraseSetsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListPhraseSetsResponse()) + await client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_phrase_sets_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_phrase_sets( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_phrase_sets_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_sets( + cloud_speech.ListPhraseSetsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_phrase_sets_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.ListPhraseSetsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_phrase_sets( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_phrase_sets_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_phrase_sets( + cloud_speech.ListPhraseSetsRequest(), + parent='parent_value', + ) + + +def test_list_phrase_sets_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_phrase_sets(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.PhraseSet) + for i in results) +def test_list_phrase_sets_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = list(client.list_phrase_sets(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_phrase_sets(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.PhraseSet) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_phrase_sets(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet( + name='name_value', + uid='uid_value', + boost=0.551, + display_name='display_name_value', + state=cloud_speech.PhraseSet.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + response = client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.PhraseSet) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.PhraseSet.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_phrase_set_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 = SpeechClient( + 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_phrase_set), + '__call__') as call: + client.get_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + +@pytest.mark.asyncio +async def test_get_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.GetPhraseSetRequest): + client = SpeechAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.PhraseSet( + name='name_value', + uid='uid_value', + boost=0.551, + display_name='display_name_value', + state=cloud_speech.PhraseSet.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + )) + response = await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.PhraseSet) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.PhraseSet.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +@pytest.mark.asyncio +async def test_get_phrase_set_async_from_dict(): + await test_get_phrase_set_async(request_type=dict) + + +def test_get_phrase_set_field_headers(): + client = SpeechClient( + 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 = cloud_speech.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = cloud_speech.PhraseSet() + client.get_phrase_set(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_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.GetPhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.PhraseSet()) + await client.get_phrase_set(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_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_phrase_set_flattened_error(): + client = SpeechClient( + 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_phrase_set( + cloud_speech.GetPhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + 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_phrase_set( + cloud_speech.GetPhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_phrase_set_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 = SpeechClient( + 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_phrase_set), + '__call__') as call: + client.update_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + +@pytest.mark.asyncio +async def test_update_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UpdatePhraseSetRequest): + client = SpeechAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_phrase_set_async_from_dict(): + await test_update_phrase_set_async(request_type=dict) + + +def test_update_phrase_set_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UpdatePhraseSetRequest() + + request.phrase_set.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_phrase_set(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', + 'phrase_set.name=name_value', + ) in kw['metadata'] + + +def test_update_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_phrase_set( + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_phrase_set_flattened_error(): + client = SpeechClient( + 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_phrase_set( + cloud_speech.UpdatePhraseSetRequest(), + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_phrase_set( + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + 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_phrase_set( + cloud_speech.UpdatePhraseSetRequest(), + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set(request_type, transport: str = 'grpc'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_phrase_set_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 = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + client.delete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + +@pytest.mark.asyncio +async def test_delete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.DeletePhraseSetRequest): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async_from_dict(): + await test_delete_phrase_set_async(request_type=dict) + + +def test_delete_phrase_set_field_headers(): + client = SpeechClient( + 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 = cloud_speech.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.DeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech.DeletePhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_phrase_set( + cloud_speech.DeletePhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeletePhraseSetRequest, + dict, +]) +def test_undelete_phrase_set(request_type, transport: str = 'grpc'): + client = SpeechClient( + 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.undelete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_phrase_set_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 = SpeechClient( + 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.undelete_phrase_set), + '__call__') as call: + client.undelete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + +@pytest.mark.asyncio +async def test_undelete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.UndeletePhraseSetRequest): + client = SpeechAsyncClient( + 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.undelete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_async_from_dict(): + await test_undelete_phrase_set_async(request_type=dict) + + +def test_undelete_phrase_set_field_headers(): + client = SpeechClient( + 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 = cloud_speech.UndeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.undelete_phrase_set(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_undelete_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + 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 = cloud_speech.UndeletePhraseSetRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.undelete_phrase_set(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_undelete_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_undelete_phrase_set_flattened_error(): + client = SpeechClient( + 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.undelete_phrase_set( + cloud_speech.UndeletePhraseSetRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_undelete_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_phrase_set( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_undelete_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + 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.undelete_phrase_set( + cloud_speech.UndeletePhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreateRecognizerRequest, + dict, +]) +def test_create_recognizer_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["recognizer"] = {'name': 'name_value', 'uid': 'uid_value', 'display_name': 'display_name_value', 'model': 'model_value', 'language_codes': ['language_codes_value1', 'language_codes_value2'], 'default_recognition_config': {'auto_decoding_config': {}, 'explicit_decoding_config': {'encoding': 1, 'sample_rate_hertz': 1817, 'audio_channel_count': 2002}, 'model': 'model_value', 'language_codes': ['language_codes_value1', 'language_codes_value2'], 'features': {'profanity_filter': True, 'enable_word_time_offsets': True, 'enable_word_confidence': True, 'enable_automatic_punctuation': True, 'enable_spoken_punctuation': True, 'enable_spoken_emojis': True, 'multi_channel_mode': 1, 'diarization_config': {'min_speaker_count': 1814, 'max_speaker_count': 1816}, 'max_alternatives': 1719}, 'adaptation': {'phrase_sets': [{'phrase_set': 'phrase_set_value', 'inline_phrase_set': {'name': 'name_value', 'uid': 'uid_value', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551, 'display_name': 'display_name_value', 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'}}], 'custom_classes': [{'name': 'name_value', 'uid': 'uid_value', 'display_name': 'display_name_value', 'items': [{'value': 'value_value'}], 'state': 2, 'create_time': {}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'}]}, 'transcript_normalization': {'entries': [{'search': 'search_value', 'replace': 'replace_value', 'case_sensitive': True}]}}, 'annotations': {}, 'state': 2, 'create_time': {}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.CreateRecognizerRequest.meta.fields["recognizer"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["recognizer"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["recognizer"][field])): + del request_init["recognizer"][field][i][subfield] + else: + del request_init["recognizer"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_recognizer(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_create_recognizer_rest_required_fields(request_type=cloud_speech.CreateRecognizerRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_recognizer._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("recognizer_id", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_recognizer(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_recognizer_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_recognizer._get_unset_required_fields({}) + assert set(unset_fields) == (set(("recognizerId", "validateOnly", )) & set(("recognizer", "parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_recognizer_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_create_recognizer") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_create_recognizer") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.CreateRecognizerRequest.pb(cloud_speech.CreateRecognizerRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.CreateRecognizerRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.create_recognizer(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_recognizer_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.CreateRecognizerRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_recognizer(request) + + +def test_create_recognizer_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_recognizer(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/recognizers" % client.transport._host, args[1]) + + +def test_create_recognizer_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_recognizer( + cloud_speech.CreateRecognizerRequest(), + parent='parent_value', + recognizer=cloud_speech.Recognizer(name='name_value'), + recognizer_id='recognizer_id_value', + ) + + +def test_create_recognizer_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListRecognizersRequest, + dict, +]) +def test_list_recognizers_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListRecognizersResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListRecognizersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_recognizers(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecognizersPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_recognizers_rest_required_fields(request_type=cloud_speech.ListRecognizersRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_recognizers._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_recognizers._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "show_deleted", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListRecognizersResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.ListRecognizersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_recognizers(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_recognizers_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_recognizers._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "showDeleted", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_recognizers_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_list_recognizers") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_list_recognizers") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.ListRecognizersRequest.pb(cloud_speech.ListRecognizersRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.ListRecognizersResponse.to_json(cloud_speech.ListRecognizersResponse()) + + request = cloud_speech.ListRecognizersRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.ListRecognizersResponse() + + client.list_recognizers(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_recognizers_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.ListRecognizersRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_recognizers(request) + + +def test_list_recognizers_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListRecognizersResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListRecognizersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_recognizers(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/recognizers" % client.transport._host, args[1]) + + +def test_list_recognizers_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_recognizers( + cloud_speech.ListRecognizersRequest(), + parent='parent_value', + ) + + +def test_list_recognizers_rest_pager(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token='abc', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token='def', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token='ghi', + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech.ListRecognizersResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_recognizers(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.Recognizer) + for i in results) + + pages = list(client.list_recognizers(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetRecognizerRequest, + dict, +]) +def test_get_recognizer_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Recognizer( + name='name_value', + uid='uid_value', + display_name='display_name_value', + model='model_value', + language_codes=['language_codes_value'], + state=cloud_speech.Recognizer.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Recognizer.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_recognizer(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Recognizer) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.model == 'model_value' + assert response.language_codes == ['language_codes_value'] + assert response.state == cloud_speech.Recognizer.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_recognizer_rest_required_fields(request_type=cloud_speech.GetRecognizerRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Recognizer() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.Recognizer.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_recognizer(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_recognizer_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_recognizer._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_recognizer_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_get_recognizer") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_get_recognizer") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.GetRecognizerRequest.pb(cloud_speech.GetRecognizerRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.Recognizer.to_json(cloud_speech.Recognizer()) + + request = cloud_speech.GetRecognizerRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.Recognizer() + + client.get_recognizer(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_recognizer_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.GetRecognizerRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_recognizer(request) + + +def test_get_recognizer_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Recognizer() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Recognizer.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_recognizer(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/recognizers/*}" % client.transport._host, args[1]) + + +def test_get_recognizer_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_recognizer( + cloud_speech.GetRecognizerRequest(), + name='name_value', + ) + + +def test_get_recognizer_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateRecognizerRequest, + dict, +]) +def test_update_recognizer_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': {'name': 'projects/sample1/locations/sample2/recognizers/sample3'}} + request_init["recognizer"] = {'name': 'projects/sample1/locations/sample2/recognizers/sample3', 'uid': 'uid_value', 'display_name': 'display_name_value', 'model': 'model_value', 'language_codes': ['language_codes_value1', 'language_codes_value2'], 'default_recognition_config': {'auto_decoding_config': {}, 'explicit_decoding_config': {'encoding': 1, 'sample_rate_hertz': 1817, 'audio_channel_count': 2002}, 'model': 'model_value', 'language_codes': ['language_codes_value1', 'language_codes_value2'], 'features': {'profanity_filter': True, 'enable_word_time_offsets': True, 'enable_word_confidence': True, 'enable_automatic_punctuation': True, 'enable_spoken_punctuation': True, 'enable_spoken_emojis': True, 'multi_channel_mode': 1, 'diarization_config': {'min_speaker_count': 1814, 'max_speaker_count': 1816}, 'max_alternatives': 1719}, 'adaptation': {'phrase_sets': [{'phrase_set': 'phrase_set_value', 'inline_phrase_set': {'name': 'name_value', 'uid': 'uid_value', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551, 'display_name': 'display_name_value', 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'}}], 'custom_classes': [{'name': 'name_value', 'uid': 'uid_value', 'display_name': 'display_name_value', 'items': [{'value': 'value_value'}], 'state': 2, 'create_time': {}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'}]}, 'transcript_normalization': {'entries': [{'search': 'search_value', 'replace': 'replace_value', 'case_sensitive': True}]}}, 'annotations': {}, 'state': 2, 'create_time': {}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.UpdateRecognizerRequest.meta.fields["recognizer"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["recognizer"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["recognizer"][field])): + del request_init["recognizer"][field][i][subfield] + else: + del request_init["recognizer"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_recognizer(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_recognizer_rest_required_fields(request_type=cloud_speech.UpdateRecognizerRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_recognizer._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_recognizer(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_recognizer_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_recognizer._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", "validateOnly", )) & set(("recognizer", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_recognizer_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_update_recognizer") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_update_recognizer") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UpdateRecognizerRequest.pb(cloud_speech.UpdateRecognizerRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UpdateRecognizerRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_recognizer(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_recognizer_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UpdateRecognizerRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': {'name': 'projects/sample1/locations/sample2/recognizers/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_recognizer(request) + + +def test_update_recognizer_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'recognizer': {'name': 'projects/sample1/locations/sample2/recognizers/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_recognizer(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{recognizer.name=projects/*/locations/*/recognizers/*}" % client.transport._host, args[1]) + + +def test_update_recognizer_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_recognizer( + cloud_speech.UpdateRecognizerRequest(), + recognizer=cloud_speech.Recognizer(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_recognizer_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeleteRecognizerRequest, + dict, +]) +def test_delete_recognizer_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_recognizer(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_recognizer_rest_required_fields(request_type=cloud_speech.DeleteRecognizerRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_recognizer._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("allow_missing", "etag", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_recognizer(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_recognizer_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_recognizer._get_unset_required_fields({}) + assert set(unset_fields) == (set(("allowMissing", "etag", "validateOnly", )) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_recognizer_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_delete_recognizer") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_delete_recognizer") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.DeleteRecognizerRequest.pb(cloud_speech.DeleteRecognizerRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.DeleteRecognizerRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_recognizer(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_recognizer_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.DeleteRecognizerRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_recognizer(request) + + +def test_delete_recognizer_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_recognizer(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/recognizers/*}" % client.transport._host, args[1]) + + +def test_delete_recognizer_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_recognizer( + cloud_speech.DeleteRecognizerRequest(), + name='name_value', + ) + + +def test_delete_recognizer_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeleteRecognizerRequest, + dict, +]) +def test_undelete_recognizer_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.undelete_recognizer(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_undelete_recognizer_rest_required_fields(request_type=cloud_speech.UndeleteRecognizerRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_recognizer._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.undelete_recognizer(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_undelete_recognizer_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.undelete_recognizer._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_undelete_recognizer_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_undelete_recognizer") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_undelete_recognizer") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UndeleteRecognizerRequest.pb(cloud_speech.UndeleteRecognizerRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UndeleteRecognizerRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.undelete_recognizer(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_undelete_recognizer_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UndeleteRecognizerRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.undelete_recognizer(request) + + +def test_undelete_recognizer_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/recognizers/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.undelete_recognizer(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/recognizers/*}:undelete" % client.transport._host, args[1]) + + +def test_undelete_recognizer_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_recognizer( + cloud_speech.UndeleteRecognizerRequest(), + name='name_value', + ) + + +def test_undelete_recognizer_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.RecognizeRequest, + dict, +]) +def test_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.recognize(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +def test_recognize_rest_required_fields(request_type=cloud_speech.RecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["recognizer"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["recognizer"] = 'recognizer_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "recognizer" in jsonified_request + assert jsonified_request["recognizer"] == 'recognizer_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("recognizer", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.RecognizeRequest.pb(cloud_speech.RecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.RecognizeResponse.to_json(cloud_speech.RecognizeResponse()) + + request = cloud_speech.RecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.RecognizeResponse() + + client.recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.RecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.recognize(request) + + +def test_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.RecognizeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.RecognizeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{recognizer=projects/*/locations/*/recognizers/*}:recognize" % client.transport._host, args[1]) + + +def test_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.recognize( + cloud_speech.RecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + content=b'content_blob', + uri='uri_value', + ) + + +def test_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_streaming_recognize_rest_no_http_options(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = cloud_speech.StreamingRecognizeRequest() + requests = [request] + with pytest.raises(RuntimeError): + client.streaming_recognize(requests) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.BatchRecognizeRequest, + dict, +]) +def test_batch_recognize_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.batch_recognize(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_batch_recognize_rest_required_fields(request_type=cloud_speech.BatchRecognizeRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["recognizer"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["recognizer"] = 'recognizer_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_recognize._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "recognizer" in jsonified_request + assert jsonified_request["recognizer"] == 'recognizer_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.batch_recognize(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_batch_recognize_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.batch_recognize._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("recognizer", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_recognize_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_batch_recognize") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_batch_recognize") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.BatchRecognizeRequest.pb(cloud_speech.BatchRecognizeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.BatchRecognizeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.batch_recognize(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_recognize_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.BatchRecognizeRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_recognize(request) + + +def test_batch_recognize_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'recognizer': 'projects/sample1/locations/sample2/recognizers/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.batch_recognize(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{recognizer=projects/*/locations/*/recognizers/*}:batchRecognize" % client.transport._host, args[1]) + + +def test_batch_recognize_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_recognize( + cloud_speech.BatchRecognizeRequest(), + recognizer='recognizer_value', + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + files=[cloud_speech.BatchRecognizeFileMetadata(uri='uri_value')], + ) + + +def test_batch_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetConfigRequest, + dict, +]) +def test_get_config_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/config'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +def test_get_config_rest_required_fields(request_type=cloud_speech.GetConfigRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_config._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_config._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_config(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_config_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_config_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_get_config") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_get_config") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.GetConfigRequest.pb(cloud_speech.GetConfigRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.Config.to_json(cloud_speech.Config()) + + request = cloud_speech.GetConfigRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.Config() + + client.get_config(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_config_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.GetConfigRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/config'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_config(request) + + +def test_get_config_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/config'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_config(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/config}" % client.transport._host, args[1]) + + +def test_get_config_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_config( + cloud_speech.GetConfigRequest(), + name='name_value', + ) + + +def test_get_config_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateConfigRequest, + dict, +]) +def test_update_config_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'config': {'name': 'projects/sample1/locations/sample2/config'}} + request_init["config"] = {'name': 'projects/sample1/locations/sample2/config', 'kms_key_name': 'kms_key_name_value', 'update_time': {'seconds': 751, 'nanos': 543}} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.UpdateConfigRequest.meta.fields["config"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["config"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["config"][field])): + del request_init["config"][field][i][subfield] + else: + del request_init["config"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config( + name='name_value', + kms_key_name='kms_key_name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == 'name_value' + assert response.kms_key_name == 'kms_key_name_value' + + +def test_update_config_rest_required_fields(request_type=cloud_speech.UpdateConfigRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_config._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_config._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_config(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_config_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("config", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_config_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_update_config") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_update_config") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UpdateConfigRequest.pb(cloud_speech.UpdateConfigRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.Config.to_json(cloud_speech.Config()) + + request = cloud_speech.UpdateConfigRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.Config() + + client.update_config(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_config_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UpdateConfigRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'config': {'name': 'projects/sample1/locations/sample2/config'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_config(request) + + +def test_update_config_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.Config() + + # get arguments that satisfy an http rule for this method + sample_request = {'config': {'name': 'projects/sample1/locations/sample2/config'}} + + # get truthy value for each flattened field + mock_args = dict( + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.Config.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_config(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{config.name=projects/*/locations/*/config}" % client.transport._host, args[1]) + + +def test_update_config_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_config( + cloud_speech.UpdateConfigRequest(), + config=cloud_speech.Config(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_config_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreateCustomClassRequest, + dict, +]) +def test_create_custom_class_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["custom_class"] = {'name': 'name_value', 'uid': 'uid_value', 'display_name': 'display_name_value', 'items': [{'value': 'value_value'}], 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.CreateCustomClassRequest.meta.fields["custom_class"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["custom_class"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["custom_class"][field])): + del request_init["custom_class"][field][i][subfield] + else: + del request_init["custom_class"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_custom_class(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_create_custom_class_rest_required_fields(request_type=cloud_speech.CreateCustomClassRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_custom_class._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("custom_class_id", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_custom_class_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(("customClassId", "validateOnly", )) & set(("customClass", "parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_custom_class_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_create_custom_class") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_create_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.CreateCustomClassRequest.pb(cloud_speech.CreateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.CreateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.create_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.CreateCustomClassRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_custom_class(request) + + +def test_create_custom_class_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_create_custom_class_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_custom_class( + cloud_speech.CreateCustomClassRequest(), + parent='parent_value', + custom_class=cloud_speech.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +def test_create_custom_class_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListCustomClassesRequest, + dict, +]) +def test_list_custom_classes_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_custom_classes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_rest_required_fields(request_type=cloud_speech.ListCustomClassesRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_custom_classes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "show_deleted", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListCustomClassesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_custom_classes(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_custom_classes_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_custom_classes._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "showDeleted", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_custom_classes_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_list_custom_classes") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_list_custom_classes") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.ListCustomClassesRequest.pb(cloud_speech.ListCustomClassesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.ListCustomClassesResponse.to_json(cloud_speech.ListCustomClassesResponse()) + + request = cloud_speech.ListCustomClassesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.ListCustomClassesResponse() + + client.list_custom_classes(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_custom_classes_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.ListCustomClassesRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_custom_classes(request) + + +def test_list_custom_classes_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListCustomClassesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListCustomClassesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_custom_classes(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/customClasses" % client.transport._host, args[1]) + + +def test_list_custom_classes_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_rest_pager(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech.ListCustomClassesResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_custom_classes(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.CustomClass) + for i in results) + + pages = list(client.list_custom_classes(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetCustomClassRequest, + dict, +]) +def test_get_custom_class_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.CustomClass( + name='name_value', + uid='uid_value', + display_name='display_name_value', + state=cloud_speech.CustomClass.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_custom_class(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.CustomClass) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.CustomClass.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_custom_class_rest_required_fields(request_type=cloud_speech.GetCustomClassRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.CustomClass() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_custom_class_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_custom_class_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_get_custom_class") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_get_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.GetCustomClassRequest.pb(cloud_speech.GetCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.CustomClass.to_json(cloud_speech.CustomClass()) + + request = cloud_speech.GetCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.CustomClass() + + client.get_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.GetCustomClassRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_custom_class(request) + + +def test_get_custom_class_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.CustomClass() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.CustomClass.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_get_custom_class_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_custom_class( + cloud_speech.GetCustomClassRequest(), + name='name_value', + ) + + +def test_get_custom_class_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdateCustomClassRequest, + dict, +]) +def test_update_custom_class_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request_init["custom_class"] = {'name': 'projects/sample1/locations/sample2/customClasses/sample3', 'uid': 'uid_value', 'display_name': 'display_name_value', 'items': [{'value': 'value_value'}], 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.UpdateCustomClassRequest.meta.fields["custom_class"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["custom_class"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["custom_class"][field])): + del request_init["custom_class"][field][i][subfield] + else: + del request_init["custom_class"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_custom_class(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_custom_class_rest_required_fields(request_type=cloud_speech.UpdateCustomClassRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_custom_class._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_custom_class_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", "validateOnly", )) & set(("customClass", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_custom_class_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_update_custom_class") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_update_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UpdateCustomClassRequest.pb(cloud_speech.UpdateCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UpdateCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UpdateCustomClassRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_custom_class(request) + + +def test_update_custom_class_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'custom_class': {'name': 'projects/sample1/locations/sample2/customClasses/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{custom_class.name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_update_custom_class_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_custom_class( + cloud_speech.UpdateCustomClassRequest(), + custom_class=cloud_speech.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_custom_class_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeleteCustomClassRequest, + dict, +]) +def test_delete_custom_class_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_custom_class(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_custom_class_rest_required_fields(request_type=cloud_speech.DeleteCustomClassRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_custom_class._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("allow_missing", "etag", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_custom_class_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(("allowMissing", "etag", "validateOnly", )) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_custom_class_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_delete_custom_class") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_delete_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.DeleteCustomClassRequest.pb(cloud_speech.DeleteCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.DeleteCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.DeleteCustomClassRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_custom_class(request) + + +def test_delete_custom_class_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/customClasses/*}" % client.transport._host, args[1]) + + +def test_delete_custom_class_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech.DeleteCustomClassRequest(), + name='name_value', + ) + + +def test_delete_custom_class_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeleteCustomClassRequest, + dict, +]) +def test_undelete_custom_class_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.undelete_custom_class(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_undelete_custom_class_rest_required_fields(request_type=cloud_speech.UndeleteCustomClassRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_custom_class._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.undelete_custom_class(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_undelete_custom_class_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.undelete_custom_class._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_undelete_custom_class_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_undelete_custom_class") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_undelete_custom_class") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UndeleteCustomClassRequest.pb(cloud_speech.UndeleteCustomClassRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UndeleteCustomClassRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.undelete_custom_class(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_undelete_custom_class_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UndeleteCustomClassRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.undelete_custom_class(request) + + +def test_undelete_custom_class_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/customClasses/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.undelete_custom_class(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/customClasses/*}:undelete" % client.transport._host, args[1]) + + +def test_undelete_custom_class_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_custom_class( + cloud_speech.UndeleteCustomClassRequest(), + name='name_value', + ) + + +def test_undelete_custom_class_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.CreatePhraseSetRequest, + dict, +]) +def test_create_phrase_set_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["phrase_set"] = {'name': 'name_value', 'uid': 'uid_value', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551, 'display_name': 'display_name_value', 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.CreatePhraseSetRequest.meta.fields["phrase_set"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["phrase_set"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["phrase_set"][field])): + del request_init["phrase_set"][field][i][subfield] + else: + del request_init["phrase_set"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_create_phrase_set_rest_required_fields(request_type=cloud_speech.CreatePhraseSetRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("phrase_set_id", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_phrase_set_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("phraseSetId", "validateOnly", )) & set(("phraseSet", "parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_phrase_set_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_create_phrase_set") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_create_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.CreatePhraseSetRequest.pb(cloud_speech.CreatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.CreatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.create_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.CreatePhraseSetRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_phrase_set(request) + + +def test_create_phrase_set_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_create_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_phrase_set( + cloud_speech.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=cloud_speech.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +def test_create_phrase_set_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.ListPhraseSetsRequest, + dict, +]) +def test_list_phrase_sets_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListPhraseSetsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListPhraseSetsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_phrase_sets(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_sets_rest_required_fields(request_type=cloud_speech.ListPhraseSetsRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_phrase_sets._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "show_deleted", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListPhraseSetsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.ListPhraseSetsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_phrase_sets(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_phrase_sets_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_phrase_sets._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "showDeleted", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_phrase_sets_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_list_phrase_sets") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_list_phrase_sets") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.ListPhraseSetsRequest.pb(cloud_speech.ListPhraseSetsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.ListPhraseSetsResponse.to_json(cloud_speech.ListPhraseSetsResponse()) + + request = cloud_speech.ListPhraseSetsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.ListPhraseSetsResponse() + + client.list_phrase_sets(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_phrase_sets_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.ListPhraseSetsRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_phrase_sets(request) + + +def test_list_phrase_sets_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.ListPhraseSetsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.ListPhraseSetsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_phrase_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/phraseSets" % client.transport._host, args[1]) + + +def test_list_phrase_sets_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_sets( + cloud_speech.ListPhraseSetsRequest(), + parent='parent_value', + ) + + +def test_list_phrase_sets_rest_pager(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_speech.ListPhraseSetsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_phrase_sets(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.PhraseSet) + for i in results) + + pages = list(client.list_phrase_sets(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.GetPhraseSetRequest, + dict, +]) +def test_get_phrase_set_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.PhraseSet( + name='name_value', + uid='uid_value', + boost=0.551, + display_name='display_name_value', + state=cloud_speech.PhraseSet.State.ACTIVE, + etag='etag_value', + reconciling=True, + kms_key_name='kms_key_name_value', + kms_key_version_name='kms_key_version_name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_phrase_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.PhraseSet) + assert response.name == 'name_value' + assert response.uid == 'uid_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + assert response.display_name == 'display_name_value' + assert response.state == cloud_speech.PhraseSet.State.ACTIVE + assert response.etag == 'etag_value' + assert response.reconciling is True + assert response.kms_key_name == 'kms_key_name_value' + assert response.kms_key_version_name == 'kms_key_version_name_value' + + +def test_get_phrase_set_rest_required_fields(request_type=cloud_speech.GetPhraseSetRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_speech.PhraseSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloud_speech.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_phrase_set_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_phrase_set_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.SpeechRestInterceptor, "post_get_phrase_set") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_get_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.GetPhraseSetRequest.pb(cloud_speech.GetPhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_speech.PhraseSet.to_json(cloud_speech.PhraseSet()) + + request = cloud_speech.GetPhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_speech.PhraseSet() + + client.get_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.GetPhraseSetRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_phrase_set(request) + + +def test_get_phrase_set_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_speech.PhraseSet() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloud_speech.PhraseSet.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_get_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_phrase_set( + cloud_speech.GetPhraseSetRequest(), + name='name_value', + ) + + +def test_get_phrase_set_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UpdatePhraseSetRequest, + dict, +]) +def test_update_phrase_set_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request_init["phrase_set"] = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3', 'uid': 'uid_value', 'phrases': [{'value': 'value_value', 'boost': 0.551}], 'boost': 0.551, 'display_name': 'display_name_value', 'state': 2, 'create_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'delete_time': {}, 'expire_time': {}, 'annotations': {}, 'etag': 'etag_value', 'reconciling': True, 'kms_key_name': 'kms_key_name_value', 'kms_key_version_name': 'kms_key_version_name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloud_speech.UpdatePhraseSetRequest.meta.fields["phrase_set"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["phrase_set"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["phrase_set"][field])): + del request_init["phrase_set"][field][i][subfield] + else: + del request_init["phrase_set"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_phrase_set_rest_required_fields(request_type=cloud_speech.UpdatePhraseSetRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_phrase_set_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", "validateOnly", )) & set(("phraseSet", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_phrase_set_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_update_phrase_set") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_update_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UpdatePhraseSetRequest.pb(cloud_speech.UpdatePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UpdatePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UpdatePhraseSetRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_phrase_set(request) + + +def test_update_phrase_set_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'phrase_set': {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{phrase_set.name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_update_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_phrase_set( + cloud_speech.UpdatePhraseSetRequest(), + phrase_set=cloud_speech.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_phrase_set_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.DeletePhraseSetRequest, + dict, +]) +def test_delete_phrase_set_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_phrase_set_rest_required_fields(request_type=cloud_speech.DeletePhraseSetRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_phrase_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("allow_missing", "etag", "validate_only", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_phrase_set_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("allowMissing", "etag", "validateOnly", )) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_phrase_set_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_delete_phrase_set") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_delete_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.DeletePhraseSetRequest.pb(cloud_speech.DeletePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.DeletePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.DeletePhraseSetRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_phrase_set(request) + + +def test_delete_phrase_set_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/phraseSets/*}" % client.transport._host, args[1]) + + +def test_delete_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech.DeletePhraseSetRequest(), + name='name_value', + ) + + +def test_delete_phrase_set_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_speech.UndeletePhraseSetRequest, + dict, +]) +def test_undelete_phrase_set_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.undelete_phrase_set(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_undelete_phrase_set_rest_required_fields(request_type=cloud_speech.UndeletePhraseSetRequest): + transport_class = transports.SpeechRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).undelete_phrase_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.undelete_phrase_set(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_undelete_phrase_set_rest_unset_required_fields(): + transport = transports.SpeechRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.undelete_phrase_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_undelete_phrase_set_rest_interceptors(null_interceptor): + transport = transports.SpeechRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.SpeechRestInterceptor(), + ) + client = SpeechClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.SpeechRestInterceptor, "post_undelete_phrase_set") as post, \ + mock.patch.object(transports.SpeechRestInterceptor, "pre_undelete_phrase_set") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_speech.UndeletePhraseSetRequest.pb(cloud_speech.UndeletePhraseSetRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_speech.UndeletePhraseSetRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.undelete_phrase_set(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_undelete_phrase_set_rest_bad_request(transport: str = 'rest', request_type=cloud_speech.UndeletePhraseSetRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.undelete_phrase_set(request) + + +def test_undelete_phrase_set_rest_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/phraseSets/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.undelete_phrase_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/phraseSets/*}:undelete" % client.transport._host, args[1]) + + +def test_undelete_phrase_set_rest_flattened_error(transport: str = 'rest'): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_phrase_set( + cloud_speech.UndeletePhraseSetRequest(), + name='name_value', + ) + + +def test_undelete_phrase_set_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_streaming_recognize_rest_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + # Since a `google.api.http` annotation is required for using a rest transport + # method, this should error. + with pytest.raises(NotImplementedError) as not_implemented_error: + client.streaming_recognize({}) + assert ( + "Method StreamingRecognize is not available over REST transport" + in str(not_implemented_error.value) + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = SpeechClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v2.services.speech.transports.SpeechTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_recognizer', + 'list_recognizers', + 'get_recognizer', + 'update_recognizer', + 'delete_recognizer', + 'undelete_recognizer', + 'recognize', + 'streaming_recognize', + 'batch_recognize', + 'get_config', + 'update_config', + 'create_custom_class', + 'list_custom_classes', + 'get_custom_class', + 'update_custom_class', + 'delete_custom_class', + 'undelete_custom_class', + 'create_phrase_set', + 'list_phrase_sets', + 'get_phrase_set', + 'update_phrase_set', + 'delete_phrase_set', + 'undelete_phrase_set', + 'get_location', + 'list_locations', + 'get_operation', + 'cancel_operation', + 'delete_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_speech_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.speech_v2.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_speech_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.speech_v2.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +def test_speech_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) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_speech_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.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + transports.SpeechRestTransport, + ], +) +def test_speech_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_speech_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( + "speech.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="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_speech_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.SpeechRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_speech_rest_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_no_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_speech_host_with_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'speech.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://speech.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_speech_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = SpeechClient( + credentials=creds1, + transport=transport_name, + ) + client2 = SpeechClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_recognizer._session + session2 = client2.transport.create_recognizer._session + assert session1 != session2 + session1 = client1.transport.list_recognizers._session + session2 = client2.transport.list_recognizers._session + assert session1 != session2 + session1 = client1.transport.get_recognizer._session + session2 = client2.transport.get_recognizer._session + assert session1 != session2 + session1 = client1.transport.update_recognizer._session + session2 = client2.transport.update_recognizer._session + assert session1 != session2 + session1 = client1.transport.delete_recognizer._session + session2 = client2.transport.delete_recognizer._session + assert session1 != session2 + session1 = client1.transport.undelete_recognizer._session + session2 = client2.transport.undelete_recognizer._session + assert session1 != session2 + session1 = client1.transport.recognize._session + session2 = client2.transport.recognize._session + assert session1 != session2 + session1 = client1.transport.streaming_recognize._session + session2 = client2.transport.streaming_recognize._session + assert session1 != session2 + session1 = client1.transport.batch_recognize._session + session2 = client2.transport.batch_recognize._session + assert session1 != session2 + session1 = client1.transport.get_config._session + session2 = client2.transport.get_config._session + assert session1 != session2 + session1 = client1.transport.update_config._session + session2 = client2.transport.update_config._session + assert session1 != session2 + session1 = client1.transport.create_custom_class._session + session2 = client2.transport.create_custom_class._session + assert session1 != session2 + session1 = client1.transport.list_custom_classes._session + session2 = client2.transport.list_custom_classes._session + assert session1 != session2 + session1 = client1.transport.get_custom_class._session + session2 = client2.transport.get_custom_class._session + assert session1 != session2 + session1 = client1.transport.update_custom_class._session + session2 = client2.transport.update_custom_class._session + assert session1 != session2 + session1 = client1.transport.delete_custom_class._session + session2 = client2.transport.delete_custom_class._session + assert session1 != session2 + session1 = client1.transport.undelete_custom_class._session + session2 = client2.transport.undelete_custom_class._session + assert session1 != session2 + session1 = client1.transport.create_phrase_set._session + session2 = client2.transport.create_phrase_set._session + assert session1 != session2 + session1 = client1.transport.list_phrase_sets._session + session2 = client2.transport.list_phrase_sets._session + assert session1 != session2 + session1 = client1.transport.get_phrase_set._session + session2 = client2.transport.get_phrase_set._session + assert session1 != session2 + session1 = client1.transport.update_phrase_set._session + session2 = client2.transport.update_phrase_set._session + assert session1 != session2 + session1 = client1.transport.delete_phrase_set._session + session2 = client2.transport.delete_phrase_set._session + assert session1 != session2 + session1 = client1.transport.undelete_phrase_set._session + session2 = client2.transport.undelete_phrase_set._session + assert session1 != session2 +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + 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_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_speech_grpc_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_config_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}/config".format(project=project, location=location, ) + actual = SpeechClient.config_path(project, location) + assert expected == actual + + +def test_parse_config_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = SpeechClient.config_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_config_path(path) + assert expected == actual + +def test_crypto_key_path(): + project = "oyster" + location = "nudibranch" + key_ring = "cuttlefish" + crypto_key = "mussel" + expected = "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}".format(project=project, location=location, key_ring=key_ring, crypto_key=crypto_key, ) + actual = SpeechClient.crypto_key_path(project, location, key_ring, crypto_key) + assert expected == actual + + +def test_parse_crypto_key_path(): + expected = { + "project": "winkle", + "location": "nautilus", + "key_ring": "scallop", + "crypto_key": "abalone", + } + path = SpeechClient.crypto_key_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_crypto_key_path(path) + assert expected == actual + +def test_crypto_key_version_path(): + project = "squid" + location = "clam" + key_ring = "whelk" + crypto_key = "octopus" + crypto_key_version = "oyster" + expected = "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}".format(project=project, location=location, key_ring=key_ring, crypto_key=crypto_key, crypto_key_version=crypto_key_version, ) + actual = SpeechClient.crypto_key_version_path(project, location, key_ring, crypto_key, crypto_key_version) + assert expected == actual + + +def test_parse_crypto_key_version_path(): + expected = { + "project": "nudibranch", + "location": "cuttlefish", + "key_ring": "mussel", + "crypto_key": "winkle", + "crypto_key_version": "nautilus", + } + path = SpeechClient.crypto_key_version_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_crypto_key_version_path(path) + assert expected == actual + +def test_custom_class_path(): + project = "scallop" + location = "abalone" + custom_class = "squid" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = SpeechClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "clam", + "location": "whelk", + "custom_class": "octopus", + } + path = SpeechClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "oyster" + location = "nudibranch" + phrase_set = "cuttlefish" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = SpeechClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "mussel", + "location": "winkle", + "phrase_set": "nautilus", + } + path = SpeechClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_phrase_set_path(path) + assert expected == actual + +def test_recognizer_path(): + project = "scallop" + location = "abalone" + recognizer = "squid" + expected = "projects/{project}/locations/{location}/recognizers/{recognizer}".format(project=project, location=location, recognizer=recognizer, ) + actual = SpeechClient.recognizer_path(project, location, recognizer) + assert expected == actual + + +def test_parse_recognizer_path(): + expected = { + "project": "clam", + "location": "whelk", + "recognizer": "octopus", + } + path = SpeechClient.recognizer_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_recognizer_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format(folder=folder, ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format(project=project, ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_location_rest_bad_request(transport: str = 'rest', request_type=locations_pb2.GetLocationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_location(request) + +@pytest.mark.parametrize("request_type", [ + locations_pb2.GetLocationRequest, + dict, +]) +def test_get_location_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.Location() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_location(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_list_locations_rest_bad_request(transport: str = 'rest', request_type=locations_pb2.ListLocationsRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_locations(request) + +@pytest.mark.parametrize("request_type", [ + locations_pb2.ListLocationsRequest, + dict, +]) +def test_list_locations_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.ListLocationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_locations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_cancel_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.CancelOperationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.cancel_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.CancelOperationRequest, + dict, +]) +def test_cancel_operation_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '{}' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.cancel_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.DeleteOperationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.DeleteOperationRequest, + dict, +]) +def test_delete_operation_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '{}' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_delete_operation(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(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 response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation(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 response is the type that we expect. + assert response is None + +def test_delete_operation_field_headers(): + client = SpeechClient( + 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 = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.delete_operation(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=locations",) in kw["metadata"] + +def test_delete_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(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 response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation(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 response is the type that we expect. + assert response is None + +def test_cancel_operation_field_headers(): + client = SpeechClient( + 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 = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.cancel_operation(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=locations",) in kw["metadata"] + +def test_cancel_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = SpeechClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = SpeechClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = SpeechAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_locations(transport: str = "grpc"): + client = SpeechClient( + 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 = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + response = client.list_locations(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 response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) +@pytest.mark.asyncio +async def test_list_locations_async(transport: str = "grpc"): + client = SpeechAsyncClient( + 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 = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations(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 response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_list_locations_field_headers(): + client = SpeechClient( + 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 = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = locations_pb2.ListLocationsResponse() + + client.list_locations(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=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_locations_field_headers_async(): + client = SpeechAsyncClient( + 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 = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + await client.list_locations(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=locations",) in kw["metadata"] + +def test_list_locations_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + + response = client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_locations_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_location(transport: str = "grpc"): + client = SpeechClient( + 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 = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + response = client.get_location(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 response is the type that we expect. + assert isinstance(response, locations_pb2.Location) +@pytest.mark.asyncio +async def test_get_location_async(transport: str = "grpc_asyncio"): + client = SpeechAsyncClient( + 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 = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location(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 response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_get_location_field_headers(): + client = SpeechClient( + 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 = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = locations_pb2.Location() + + client.get_location(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=locations/abc",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_location_field_headers_async(): + client = SpeechAsyncClient( + 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 = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + await client.get_location(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=locations/abc",) in kw["metadata"] + +def test_get_location_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + + response = client.get_location( + request={ + "name": "locations/abc", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_location_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (SpeechClient, transports.SpeechGrpcTransport), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )