From 3fcf04bc2a9490a2acb634058e45e0f963cf7cb0 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 7 Oct 2021 19:36:41 +0000 Subject: [PATCH 1/2] feat: add context manager support in client chore: fix docstring for first attribute of protos committer: @busunkim96 PiperOrigin-RevId: 401271153 Source-Link: https://github.com/googleapis/googleapis/commit/787f8c9a731f44e74a90b9847d48659ca9462d10 Source-Link: https://github.com/googleapis/googleapis-gen/commit/81decffe9fc72396a8153e756d1d67a6eecfd620 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9 --- owl-bot-staging/v1/.coveragerc | 17 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + .../reservation_service.rst | 10 + .../docs/bigquery_reservation_v1/services.rst | 6 + .../v1/docs/bigquery_reservation_v1/types.rst | 7 + owl-bot-staging/v1/docs/conf.py | 376 + owl-bot-staging/v1/docs/index.rst | 7 + .../cloud/bigquery_reservation/__init__.py | 83 + .../cloud/bigquery_reservation/py.typed | 2 + .../cloud/bigquery_reservation_v1/__init__.py | 84 + .../gapic_metadata.json | 223 + .../cloud/bigquery_reservation_v1/py.typed | 2 + .../services/__init__.py | 15 + .../services/reservation_service/__init__.py | 22 + .../reservation_service/async_client.py | 2163 ++++++ .../services/reservation_service/client.py | 2317 ++++++ .../services/reservation_service/pagers.py | 628 ++ .../transports/__init__.py | 33 + .../reservation_service/transports/base.py | 516 ++ .../reservation_service/transports/grpc.py | 926 +++ .../transports/grpc_asyncio.py | 931 +++ .../bigquery_reservation_v1/types/__init__.py | 80 + .../types/reservation.py | 1023 +++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../fixup_bigquery_reservation_v1_keywords.py | 195 + owl-bot-staging/v1/setup.py | 54 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../gapic/bigquery_reservation_v1/__init__.py | 16 + .../test_reservation_service.py | 6795 +++++++++++++++++ 33 files changed, 16765 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst create mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 00000000..81dbade7 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/bigquery_reservation/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 00000000..c1c2e1b5 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/bigquery_reservation *.py +recursive-include google/cloud/bigquery_reservation_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 00000000..15b8ffa5 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Bigquery Reservation 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 Bigquery Reservation 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/bigquery_reservation_v1/reservation_service.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst new file mode 100644 index 00000000..35e6b3cf --- /dev/null +++ b/owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst @@ -0,0 +1,10 @@ +ReservationService +------------------------------------ + +.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service + :members: + :inherited-members: + +.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst new file mode 100644 index 00000000..3f9e9577 --- /dev/null +++ b/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Bigquery Reservation v1 API +===================================================== +.. toctree:: + :maxdepth: 2 + + reservation_service diff --git a/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst new file mode 100644 index 00000000..eca7ccfb --- /dev/null +++ b/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Bigquery Reservation v1 API +================================================== + +.. automodule:: google.cloud.bigquery_reservation_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 00000000..60f8beb4 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-bigquery-reservation documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "1.6.3" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-bigquery-reservation" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-bigquery-reservation-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "google-cloud-bigquery-reservation.tex", + u"google-cloud-bigquery-reservation Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "google-cloud-bigquery-reservation", + u"Google Cloud Bigquery Reservation Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "google-cloud-bigquery-reservation", + u"google-cloud-bigquery-reservation Documentation", + author, + "google-cloud-bigquery-reservation", + "GAPIC library for Google Cloud Bigquery Reservation 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..0f4f9035 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + bigquery_reservation_v1/services + bigquery_reservation_v1/types diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py new file mode 100644 index 00000000..9bc2ae0c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py @@ -0,0 +1,83 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.bigquery_reservation_v1.services.reservation_service.client import ReservationServiceClient +from google.cloud.bigquery_reservation_v1.services.reservation_service.async_client import ReservationServiceAsyncClient + +from google.cloud.bigquery_reservation_v1.types.reservation import Assignment +from google.cloud.bigquery_reservation_v1.types.reservation import BiReservation +from google.cloud.bigquery_reservation_v1.types.reservation import CapacityCommitment +from google.cloud.bigquery_reservation_v1.types.reservation import CreateAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import CreateCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetBiReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import MergeCapacityCommitmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import MoveAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import Reservation +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentResponse +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateBiReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateReservationRequest + +__all__ = ('ReservationServiceClient', + 'ReservationServiceAsyncClient', + 'Assignment', + 'BiReservation', + 'CapacityCommitment', + 'CreateAssignmentRequest', + 'CreateCapacityCommitmentRequest', + 'CreateReservationRequest', + 'DeleteAssignmentRequest', + 'DeleteCapacityCommitmentRequest', + 'DeleteReservationRequest', + 'GetBiReservationRequest', + 'GetCapacityCommitmentRequest', + 'GetReservationRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'MergeCapacityCommitmentsRequest', + 'MoveAssignmentRequest', + 'Reservation', + 'SearchAllAssignmentsRequest', + 'SearchAllAssignmentsResponse', + 'SearchAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'UpdateBiReservationRequest', + 'UpdateCapacityCommitmentRequest', + 'UpdateReservationRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed b/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed new file mode 100644 index 00000000..ff261ee1 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py new file mode 100644 index 00000000..db27ff62 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py @@ -0,0 +1,84 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.reservation_service import ReservationServiceClient +from .services.reservation_service import ReservationServiceAsyncClient + +from .types.reservation import Assignment +from .types.reservation import BiReservation +from .types.reservation import CapacityCommitment +from .types.reservation import CreateAssignmentRequest +from .types.reservation import CreateCapacityCommitmentRequest +from .types.reservation import CreateReservationRequest +from .types.reservation import DeleteAssignmentRequest +from .types.reservation import DeleteCapacityCommitmentRequest +from .types.reservation import DeleteReservationRequest +from .types.reservation import GetBiReservationRequest +from .types.reservation import GetCapacityCommitmentRequest +from .types.reservation import GetReservationRequest +from .types.reservation import ListAssignmentsRequest +from .types.reservation import ListAssignmentsResponse +from .types.reservation import ListCapacityCommitmentsRequest +from .types.reservation import ListCapacityCommitmentsResponse +from .types.reservation import ListReservationsRequest +from .types.reservation import ListReservationsResponse +from .types.reservation import MergeCapacityCommitmentsRequest +from .types.reservation import MoveAssignmentRequest +from .types.reservation import Reservation +from .types.reservation import SearchAllAssignmentsRequest +from .types.reservation import SearchAllAssignmentsResponse +from .types.reservation import SearchAssignmentsRequest +from .types.reservation import SearchAssignmentsResponse +from .types.reservation import SplitCapacityCommitmentRequest +from .types.reservation import SplitCapacityCommitmentResponse +from .types.reservation import UpdateBiReservationRequest +from .types.reservation import UpdateCapacityCommitmentRequest +from .types.reservation import UpdateReservationRequest + +__all__ = ( + 'ReservationServiceAsyncClient', +'Assignment', +'BiReservation', +'CapacityCommitment', +'CreateAssignmentRequest', +'CreateCapacityCommitmentRequest', +'CreateReservationRequest', +'DeleteAssignmentRequest', +'DeleteCapacityCommitmentRequest', +'DeleteReservationRequest', +'GetBiReservationRequest', +'GetCapacityCommitmentRequest', +'GetReservationRequest', +'ListAssignmentsRequest', +'ListAssignmentsResponse', +'ListCapacityCommitmentsRequest', +'ListCapacityCommitmentsResponse', +'ListReservationsRequest', +'ListReservationsResponse', +'MergeCapacityCommitmentsRequest', +'MoveAssignmentRequest', +'Reservation', +'ReservationServiceClient', +'SearchAllAssignmentsRequest', +'SearchAllAssignmentsResponse', +'SearchAssignmentsRequest', +'SearchAssignmentsResponse', +'SplitCapacityCommitmentRequest', +'SplitCapacityCommitmentResponse', +'UpdateBiReservationRequest', +'UpdateCapacityCommitmentRequest', +'UpdateReservationRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json new file mode 100644 index 00000000..d8fad3d5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json @@ -0,0 +1,223 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.bigquery_reservation_v1", + "protoPackage": "google.cloud.bigquery.reservation.v1", + "schema": "1.0", + "services": { + "ReservationService": { + "clients": { + "grpc": { + "libraryClient": "ReservationServiceClient", + "rpcs": { + "CreateAssignment": { + "methods": [ + "create_assignment" + ] + }, + "CreateCapacityCommitment": { + "methods": [ + "create_capacity_commitment" + ] + }, + "CreateReservation": { + "methods": [ + "create_reservation" + ] + }, + "DeleteAssignment": { + "methods": [ + "delete_assignment" + ] + }, + "DeleteCapacityCommitment": { + "methods": [ + "delete_capacity_commitment" + ] + }, + "DeleteReservation": { + "methods": [ + "delete_reservation" + ] + }, + "GetBiReservation": { + "methods": [ + "get_bi_reservation" + ] + }, + "GetCapacityCommitment": { + "methods": [ + "get_capacity_commitment" + ] + }, + "GetReservation": { + "methods": [ + "get_reservation" + ] + }, + "ListAssignments": { + "methods": [ + "list_assignments" + ] + }, + "ListCapacityCommitments": { + "methods": [ + "list_capacity_commitments" + ] + }, + "ListReservations": { + "methods": [ + "list_reservations" + ] + }, + "MergeCapacityCommitments": { + "methods": [ + "merge_capacity_commitments" + ] + }, + "MoveAssignment": { + "methods": [ + "move_assignment" + ] + }, + "SearchAllAssignments": { + "methods": [ + "search_all_assignments" + ] + }, + "SearchAssignments": { + "methods": [ + "search_assignments" + ] + }, + "SplitCapacityCommitment": { + "methods": [ + "split_capacity_commitment" + ] + }, + "UpdateBiReservation": { + "methods": [ + "update_bi_reservation" + ] + }, + "UpdateCapacityCommitment": { + "methods": [ + "update_capacity_commitment" + ] + }, + "UpdateReservation": { + "methods": [ + "update_reservation" + ] + } + } + }, + "grpc-async": { + "libraryClient": "ReservationServiceAsyncClient", + "rpcs": { + "CreateAssignment": { + "methods": [ + "create_assignment" + ] + }, + "CreateCapacityCommitment": { + "methods": [ + "create_capacity_commitment" + ] + }, + "CreateReservation": { + "methods": [ + "create_reservation" + ] + }, + "DeleteAssignment": { + "methods": [ + "delete_assignment" + ] + }, + "DeleteCapacityCommitment": { + "methods": [ + "delete_capacity_commitment" + ] + }, + "DeleteReservation": { + "methods": [ + "delete_reservation" + ] + }, + "GetBiReservation": { + "methods": [ + "get_bi_reservation" + ] + }, + "GetCapacityCommitment": { + "methods": [ + "get_capacity_commitment" + ] + }, + "GetReservation": { + "methods": [ + "get_reservation" + ] + }, + "ListAssignments": { + "methods": [ + "list_assignments" + ] + }, + "ListCapacityCommitments": { + "methods": [ + "list_capacity_commitments" + ] + }, + "ListReservations": { + "methods": [ + "list_reservations" + ] + }, + "MergeCapacityCommitments": { + "methods": [ + "merge_capacity_commitments" + ] + }, + "MoveAssignment": { + "methods": [ + "move_assignment" + ] + }, + "SearchAllAssignments": { + "methods": [ + "search_all_assignments" + ] + }, + "SearchAssignments": { + "methods": [ + "search_assignments" + ] + }, + "SplitCapacityCommitment": { + "methods": [ + "split_capacity_commitment" + ] + }, + "UpdateBiReservation": { + "methods": [ + "update_bi_reservation" + ] + }, + "UpdateCapacityCommitment": { + "methods": [ + "update_capacity_commitment" + ] + }, + "UpdateReservation": { + "methods": [ + "update_reservation" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed new file mode 100644 index 00000000..ff261ee1 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py new file mode 100644 index 00000000..4de65971 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py new file mode 100644 index 00000000..a9b2e046 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import ReservationServiceClient +from .async_client import ReservationServiceAsyncClient + +__all__ = ( + 'ReservationServiceClient', + 'ReservationServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py new file mode 100644 index 00000000..7258c24b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py @@ -0,0 +1,2163 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources +import warnings + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +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 +from .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport +from .client import ReservationServiceClient + + +class ReservationServiceAsyncClient: + """This API allows users to manage their flat-rate BigQuery + reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + """ + + _client: ReservationServiceClient + + DEFAULT_ENDPOINT = ReservationServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + + assignment_path = staticmethod(ReservationServiceClient.assignment_path) + parse_assignment_path = staticmethod(ReservationServiceClient.parse_assignment_path) + bi_reservation_path = staticmethod(ReservationServiceClient.bi_reservation_path) + parse_bi_reservation_path = staticmethod(ReservationServiceClient.parse_bi_reservation_path) + capacity_commitment_path = staticmethod(ReservationServiceClient.capacity_commitment_path) + parse_capacity_commitment_path = staticmethod(ReservationServiceClient.parse_capacity_commitment_path) + reservation_path = staticmethod(ReservationServiceClient.reservation_path) + parse_reservation_path = staticmethod(ReservationServiceClient.parse_reservation_path) + common_billing_account_path = staticmethod(ReservationServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(ReservationServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(ReservationServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(ReservationServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(ReservationServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(ReservationServiceClient.parse_common_organization_path) + common_project_path = staticmethod(ReservationServiceClient.common_project_path) + parse_common_project_path = staticmethod(ReservationServiceClient.parse_common_project_path) + common_location_path = staticmethod(ReservationServiceClient.common_location_path) + parse_common_location_path = staticmethod(ReservationServiceClient.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: + ReservationServiceAsyncClient: The constructed client. + """ + return ReservationServiceClient.from_service_account_info.__func__(ReservationServiceAsyncClient, 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: + ReservationServiceAsyncClient: The constructed client. + """ + return ReservationServiceClient.from_service_account_file.__func__(ReservationServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> ReservationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReservationServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(ReservationServiceClient).get_transport_class, type(ReservationServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, ReservationServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the reservation service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.ReservationServiceTransport]): 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 = ReservationServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_reservation(self, + request: gcbr_reservation.CreateReservationRequest = None, + *, + parent: str = None, + reservation: gcbr_reservation.Reservation = None, + reservation_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcbr_reservation.Reservation: + r"""Creates a new reservation resource. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.CreateReservationRequest`): + The request object. The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + parent (:class:`str`): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): + Definition of the new reservation to + create. + + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation_id (:class:`str`): + The reservation ID. This field must + only contain lower case alphanumeric + characters or dash. Max length is 64 + characters. + + This corresponds to the ``reservation_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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, reservation, reservation_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 = gcbr_reservation.CreateReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if reservation is not None: + request.reservation = reservation + if reservation_id is not None: + request.reservation_id = reservation_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_reservation, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_reservations(self, + request: reservation.ListReservationsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListReservationsAsyncPager: + r"""Lists all the reservations for the project in the + specified location. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.ListReservationsRequest`): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + parent (:class:`str`): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.ListReservationsRequest(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_reservations, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListReservationsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_reservation(self, + request: reservation.GetReservationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Reservation: + r"""Returns information about the reservation. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.GetReservationRequest`): + The request object. The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + name (:class:`str`): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.GetReservationRequest(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_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_reservation(self, + request: reservation.DeleteReservationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest`): + The request object. The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + name (:class:`str`): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.DeleteReservationRequest(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_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def update_reservation(self, + request: gcbr_reservation.UpdateReservationRequest = None, + *, + reservation: gcbr_reservation.Reservation = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcbr_reservation.Reservation: + r"""Updates an existing reservation resource. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest`): + The request object. The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): + Content of the reservation to update. + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Standard field mask for the set 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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([reservation, 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 = gcbr_reservation.UpdateReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if reservation is not None: + request.reservation = reservation + 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_reservation, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("reservation.name", request.reservation.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_capacity_commitment(self, + request: reservation.CreateCapacityCommitmentRequest = None, + *, + parent: str = None, + capacity_commitment: reservation.CapacityCommitment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Creates a new capacity commitment resource. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest`): + The request object. The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + parent (:class:`str`): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): + Content of the capacity commitment to + create. + + This corresponds to the ``capacity_commitment`` 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, capacity_commitment]) + 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 = reservation.CreateCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + + # 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_capacity_commitment, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_capacity_commitments(self, + request: reservation.ListCapacityCommitmentsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCapacityCommitmentsAsyncPager: + r"""Lists all the capacity commitments for the admin + project. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest`): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + parent (:class:`str`): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListCapacityCommitmentsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_capacity_commitment(self, + request: reservation.GetCapacityCommitmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Returns information about the capacity commitment. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest`): + The request object. The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + name (:class:`str`): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_capacity_commitment(self, + request: reservation.DeleteCapacityCommitmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest`): + The request object. The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + name (:class:`str`): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def update_capacity_commitment(self, + request: reservation.UpdateCapacityCommitmentRequest = None, + *, + capacity_commitment: reservation.CapacityCommitment = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest`): + The request object. The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): + Content of the capacity commitment to + update. + + This corresponds to the ``capacity_commitment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Standard field mask for the set 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([capacity_commitment, 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 = reservation.UpdateCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + 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_capacity_commitment, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("capacity_commitment.name", request.capacity_commitment.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def split_capacity_commitment(self, + request: reservation.SplitCapacityCommitmentRequest = None, + *, + name: str = None, + slot_count: int = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you would change the plan of the first one to + ``FLEX`` and then delete it. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest`): + The request object. The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + name (:class:`str`): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + slot_count (:class:`int`): + Number of slots in the capacity + commitment after the split. + + This corresponds to the ``slot_count`` 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.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: + The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, slot_count]) + 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 = reservation.SplitCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if slot_count is not None: + request.slot_count = slot_count + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.split_capacity_commitment, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def merge_capacity_commitments(self, + request: reservation.MergeCapacityCommitmentsRequest = None, + *, + parent: str = None, + capacity_commitment_ids: Sequence[str] = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest`): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + parent (:class:`str`): + Parent resource that identifies admin project and + location e.g., ``projects/myproject/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment_ids (:class:`Sequence[str]`): + Ids of capacity commitments to merge. + These capacity commitments must exist + under admin project and location + specified in the parent. + ID is the last portion of capacity + commitment name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + + This corresponds to the ``capacity_commitment_ids`` 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, capacity_commitment_ids]) + 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 = reservation.MergeCapacityCommitmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment_ids: + request.capacity_commitment_ids.extend(capacity_commitment_ids) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.merge_capacity_commitments, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_assignment(self, + request: reservation.CreateAssignmentRequest = None, + *, + parent: str = None, + assignment: reservation.Assignment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Assignment: + r"""Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest`): + The request object. The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" + permission is required on the related assignee. + parent (:class:`str`): + Required. The parent resource name of the assignment + E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): + Assignment resource to create. + This corresponds to the ``assignment`` 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.bigquery_reservation_v1.types.Assignment: + A Assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, assignment]) + 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 = reservation.CreateAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assignment is not None: + request.assignment = assignment + + # 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_assignment, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_assignments(self, + request: reservation.ListAssignmentsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAssignmentsAsyncPager: + r"""Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest`): + The request object. The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + parent (:class:`str`): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager: + The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.ListAssignmentsRequest(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_assignments, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_assignment(self, + request: reservation.DeleteAssignmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest`): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + name (:class:`str`): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.DeleteAssignmentRequest(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_assignment, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def search_assignments(self, + request: reservation.SearchAssignmentsRequest = None, + *, + parent: str = None, + query: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchAssignmentsAsyncPager: + r"""Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest`): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (:class:`str`): + Required. The resource name of the admin + project(containing project and location), e.g.: + ``projects/myproject/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + warnings.warn("ReservationServiceAsyncClient.search_assignments is deprecated", + DeprecationWarning) + + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, query]) + 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 = reservation.SearchAssignmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_assignments, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.SearchAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def search_all_assignments(self, + request: reservation.SearchAllAssignmentsRequest = None, + *, + parent: str = None, + query: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchAllAssignmentsAsyncPager: + r"""Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest`): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (:class:`str`): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, query]) + 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 = reservation.SearchAllAssignmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_all_assignments, + 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.SearchAllAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def move_assignment(self, + request: reservation.MoveAssignmentRequest = None, + *, + name: str = None, + destination_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Assignment: + r"""Moves an assignment under a new reservation. + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest`): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + name (:class:`str`): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + destination_id (:class:`str`): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + + This corresponds to the ``destination_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.bigquery_reservation_v1.types.Assignment: + A Assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, destination_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 = reservation.MoveAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if destination_id is not None: + request.destination_id = destination_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.move_assignment, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_bi_reservation(self, + request: reservation.GetBiReservationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.BiReservation: + r"""Retrieves a BI reservation. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest`): + The request object. A request to get a singleton BI + reservation. + name (:class:`str`): + Required. Name of the requested reservation, for + example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + + 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.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = reservation.GetBiReservationRequest(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_bi_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_bi_reservation(self, + request: reservation.UpdateBiReservationRequest = None, + *, + bi_reservation: reservation.BiReservation = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.BiReservation: + r"""Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Args: + request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest`): + The request object. A request to update a BI + reservation. + bi_reservation (:class:`google.cloud.bigquery_reservation_v1.types.BiReservation`): + A reservation to update. + This corresponds to the ``bi_reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + A list of fields to be updated in + this request. + + 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.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([bi_reservation, 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 = reservation.UpdateBiReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if bi_reservation is not None: + request.bi_reservation = bi_reservation + 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_bi_reservation, + default_timeout=300.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("bi_reservation.name", request.bi_reservation.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-bigquery-reservation", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "ReservationServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py new file mode 100644 index 00000000..d5eeb37d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py @@ -0,0 +1,2317 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources +import warnings + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +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 +from .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import ReservationServiceGrpcTransport +from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport + + +class ReservationServiceClientMeta(type): + """Metaclass for the ReservationService 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[ReservationServiceTransport]] + _transport_registry["grpc"] = ReservationServiceGrpcTransport + _transport_registry["grpc_asyncio"] = ReservationServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[ReservationServiceTransport]: + """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 ReservationServiceClient(metaclass=ReservationServiceClientMeta): + """This API allows users to manage their flat-rate BigQuery + reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + """ + + @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 = "bigqueryreservation.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: + ReservationServiceClient: 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: + ReservationServiceClient: 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) -> ReservationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReservationServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def assignment_path(project: str,location: str,reservation: str,assignment: str,) -> str: + """Returns a fully-qualified assignment string.""" + return "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) + + @staticmethod + def parse_assignment_path(path: str) -> Dict[str,str]: + """Parses a assignment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)/assignments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def bi_reservation_path(project: str,location: str,) -> str: + """Returns a fully-qualified bi_reservation string.""" + return "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) + + @staticmethod + def parse_bi_reservation_path(path: str) -> Dict[str,str]: + """Parses a bi_reservation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/biReservation$", path) + return m.groupdict() if m else {} + + @staticmethod + def capacity_commitment_path(project: str,location: str,capacity_commitment: str,) -> str: + """Returns a fully-qualified capacity_commitment string.""" + return "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) + + @staticmethod + def parse_capacity_commitment_path(path: str) -> Dict[str,str]: + """Parses a capacity_commitment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/capacityCommitments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def reservation_path(project: str,location: str,reservation: str,) -> str: + """Returns a fully-qualified reservation string.""" + return "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) + + @staticmethod + def parse_reservation_path(path: str) -> Dict[str,str]: + """Parses a reservation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, ReservationServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the reservation service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ReservationServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, ReservationServiceTransport): + # transport is a ReservationServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + ) + + def create_reservation(self, + request: Union[gcbr_reservation.CreateReservationRequest, dict] = None, + *, + parent: str = None, + reservation: gcbr_reservation.Reservation = None, + reservation_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcbr_reservation.Reservation: + r"""Creates a new reservation resource. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]): + The request object. The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Definition of the new reservation to + create. + + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation_id (str): + The reservation ID. This field must + only contain lower case alphanumeric + characters or dash. Max length is 64 + characters. + + This corresponds to the ``reservation_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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, reservation, reservation_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 gcbr_reservation.CreateReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, gcbr_reservation.CreateReservationRequest): + request = gcbr_reservation.CreateReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if reservation is not None: + request.reservation = reservation + if reservation_id is not None: + request.reservation_id = reservation_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_reservations(self, + request: Union[reservation.ListReservationsRequest, dict] = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListReservationsPager: + r"""Lists all the reservations for the project in the + specified location. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + parent (str): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.ListReservationsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.ListReservationsRequest): + request = reservation.ListReservationsRequest(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_reservations] + + # 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.ListReservationsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_reservation(self, + request: Union[reservation.GetReservationRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Reservation: + r"""Returns information about the reservation. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]): + The request object. The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.GetReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.GetReservationRequest): + request = reservation.GetReservationRequest(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_reservation] + + # 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_reservation(self, + request: Union[reservation.DeleteReservationRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]): + The request object. The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.DeleteReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.DeleteReservationRequest): + request = reservation.DeleteReservationRequest(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_reservation] + + # 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 update_reservation(self, + request: Union[gcbr_reservation.UpdateReservationRequest, dict] = None, + *, + reservation: gcbr_reservation.Reservation = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcbr_reservation.Reservation: + r"""Updates an existing reservation resource. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]): + The request object. The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Content of the reservation to update. + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set 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.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([reservation, 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 gcbr_reservation.UpdateReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, gcbr_reservation.UpdateReservationRequest): + request = gcbr_reservation.UpdateReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if reservation is not None: + request.reservation = reservation + 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_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("reservation.name", request.reservation.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_capacity_commitment(self, + request: Union[reservation.CreateCapacityCommitmentRequest, dict] = None, + *, + parent: str = None, + capacity_commitment: reservation.CapacityCommitment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Creates a new capacity commitment resource. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to + create. + + This corresponds to the ``capacity_commitment`` 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, capacity_commitment]) + 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 reservation.CreateCapacityCommitmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.CreateCapacityCommitmentRequest): + request = reservation.CreateCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_capacity_commitment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_capacity_commitments(self, + request: Union[reservation.ListCapacityCommitmentsRequest, dict] = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCapacityCommitmentsPager: + r"""Lists all the capacity commitments for the admin + project. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.ListCapacityCommitmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.ListCapacityCommitmentsRequest): + request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments] + + # 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.ListCapacityCommitmentsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_capacity_commitment(self, + request: Union[reservation.GetCapacityCommitmentRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Returns information about the capacity commitment. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + name (str): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.GetCapacityCommitmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.GetCapacityCommitmentRequest): + request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment] + + # 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_capacity_commitment(self, + request: Union[reservation.DeleteCapacityCommitmentRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + name (str): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.DeleteCapacityCommitmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): + request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment] + + # 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 update_capacity_commitment(self, + request: Union[reservation.UpdateCapacityCommitmentRequest, dict] = None, + *, + capacity_commitment: reservation.CapacityCommitment = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to + update. + + This corresponds to the ``capacity_commitment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([capacity_commitment, 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 reservation.UpdateCapacityCommitmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): + request = reservation.UpdateCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + 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_capacity_commitment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("capacity_commitment.name", request.capacity_commitment.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def split_capacity_commitment(self, + request: Union[reservation.SplitCapacityCommitmentRequest, dict] = None, + *, + name: str = None, + slot_count: int = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you would change the plan of the first one to + ``FLEX`` and then delete it. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + name (str): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + slot_count (int): + Number of slots in the capacity + commitment after the split. + + This corresponds to the ``slot_count`` 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.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: + The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, slot_count]) + 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 reservation.SplitCapacityCommitmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.SplitCapacityCommitmentRequest): + request = reservation.SplitCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if slot_count is not None: + request.slot_count = slot_count + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.split_capacity_commitment] + + # 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 merge_capacity_commitments(self, + request: Union[reservation.MergeCapacityCommitmentsRequest, dict] = None, + *, + parent: str = None, + capacity_commitment_ids: Sequence[str] = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.CapacityCommitment: + r"""Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + parent (str): + Parent resource that identifies admin project and + location e.g., ``projects/myproject/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment_ids (Sequence[str]): + Ids of capacity commitments to merge. + These capacity commitments must exist + under admin project and location + specified in the parent. + ID is the last portion of capacity + commitment name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + + This corresponds to the ``capacity_commitment_ids`` 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.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, capacity_commitment_ids]) + 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 reservation.MergeCapacityCommitmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): + request = reservation.MergeCapacityCommitmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment_ids is not None: + request.capacity_commitment_ids = capacity_commitment_ids + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.merge_capacity_commitments] + + # 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 create_assignment(self, + request: Union[reservation.CreateAssignmentRequest, dict] = None, + *, + parent: str = None, + assignment: reservation.Assignment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Assignment: + r"""Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]): + The request object. The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" + permission is required on the related assignee. + parent (str): + Required. The parent resource name of the assignment + E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Assignment resource to create. + This corresponds to the ``assignment`` 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.bigquery_reservation_v1.types.Assignment: + A Assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, assignment]) + 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 reservation.CreateAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.CreateAssignmentRequest): + request = reservation.CreateAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assignment is not None: + request.assignment = assignment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_assignment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_assignments(self, + request: Union[reservation.ListAssignmentsRequest, dict] = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAssignmentsPager: + r"""Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + parent (str): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + + 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.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager: + The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.ListAssignmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.ListAssignmentsRequest): + request = reservation.ListAssignmentsRequest(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_assignments] + + # 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.ListAssignmentsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_assignment(self, + request: Union[reservation.DeleteAssignmentRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + name (str): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + 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. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.DeleteAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.DeleteAssignmentRequest): + request = reservation.DeleteAssignmentRequest(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_assignment] + + # 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 search_assignments(self, + request: Union[reservation.SearchAssignmentsRequest, dict] = None, + *, + parent: str = None, + query: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchAssignmentsPager: + r"""Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (str): + Required. The resource name of the admin + project(containing project and location), e.g.: + ``projects/myproject/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + warnings.warn("ReservationServiceClient.search_assignments is deprecated", + DeprecationWarning) + + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, query]) + 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 reservation.SearchAssignmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.SearchAssignmentsRequest): + request = reservation.SearchAssignmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_assignments] + + # 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.SearchAssignmentsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def search_all_assignments(self, + request: Union[reservation.SearchAllAssignmentsRequest, dict] = None, + *, + parent: str = None, + query: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchAllAssignmentsPager: + r"""Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (str): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, query]) + 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 reservation.SearchAllAssignmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.SearchAllAssignmentsRequest): + request = reservation.SearchAllAssignmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_all_assignments] + + # 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.SearchAllAssignmentsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def move_assignment(self, + request: Union[reservation.MoveAssignmentRequest, dict] = None, + *, + name: str = None, + destination_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.Assignment: + r"""Moves an assignment under a new reservation. + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + name (str): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + destination_id (str): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + + This corresponds to the ``destination_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.bigquery_reservation_v1.types.Assignment: + A Assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, destination_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 reservation.MoveAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.MoveAssignmentRequest): + request = reservation.MoveAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if destination_id is not None: + request.destination_id = destination_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.move_assignment] + + # 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_bi_reservation(self, + request: Union[reservation.GetBiReservationRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.BiReservation: + r"""Retrieves a BI reservation. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]): + The request object. A request to get a singleton BI + reservation. + name (str): + Required. Name of the requested reservation, for + example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + + 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.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a reservation.GetBiReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.GetBiReservationRequest): + request = reservation.GetBiReservationRequest(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_bi_reservation] + + # 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_bi_reservation(self, + request: Union[reservation.UpdateBiReservationRequest, dict] = None, + *, + bi_reservation: reservation.BiReservation = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> reservation.BiReservation: + r"""Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]): + The request object. A request to update a BI + reservation. + bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): + A reservation to update. + This corresponds to the ``bi_reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + A list of fields to be updated in + this request. + + 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.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([bi_reservation, 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 reservation.UpdateBiReservationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, reservation.UpdateBiReservationRequest): + request = reservation.UpdateBiReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if bi_reservation is not None: + request.bi_reservation = bi_reservation + 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_bi_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("bi_reservation.name", request.bi_reservation.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self): + 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() + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-bigquery-reservation", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "ReservationServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py new file mode 100644 index 00000000..bad68017 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py @@ -0,0 +1,628 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.bigquery_reservation_v1.types import reservation + + +class ListReservationsPager: + """A pager for iterating through ``list_reservations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``reservations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListReservations`` requests and continue to iterate + through the ``reservations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` + 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[..., reservation.ListReservationsResponse], + request: reservation.ListReservationsRequest, + response: reservation.ListReservationsResponse, + *, + 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.bigquery_reservation_v1.types.ListReservationsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): + 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 = reservation.ListReservationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListReservationsResponse]: + 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[reservation.Reservation]: + for page in self.pages: + yield from page.reservations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListReservationsAsyncPager: + """A pager for iterating through ``list_reservations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``reservations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListReservations`` requests and continue to iterate + through the ``reservations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` + 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[reservation.ListReservationsResponse]], + request: reservation.ListReservationsRequest, + response: reservation.ListReservationsResponse, + *, + 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.bigquery_reservation_v1.types.ListReservationsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): + 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 = reservation.ListReservationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListReservationsResponse]: + 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[reservation.Reservation]: + async def async_generator(): + async for page in self.pages: + for response in page.reservations: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCapacityCommitmentsPager: + """A pager for iterating through ``list_capacity_commitments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``capacity_commitments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCapacityCommitments`` requests and continue to iterate + through the ``capacity_commitments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` + 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[..., reservation.ListCapacityCommitmentsResponse], + request: reservation.ListCapacityCommitmentsRequest, + response: reservation.ListCapacityCommitmentsResponse, + *, + 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.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): + 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 = reservation.ListCapacityCommitmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListCapacityCommitmentsResponse]: + 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[reservation.CapacityCommitment]: + for page in self.pages: + yield from page.capacity_commitments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCapacityCommitmentsAsyncPager: + """A pager for iterating through ``list_capacity_commitments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``capacity_commitments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCapacityCommitments`` requests and continue to iterate + through the ``capacity_commitments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` + 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[reservation.ListCapacityCommitmentsResponse]], + request: reservation.ListCapacityCommitmentsRequest, + response: reservation.ListCapacityCommitmentsResponse, + *, + 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.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): + 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 = reservation.ListCapacityCommitmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListCapacityCommitmentsResponse]: + 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[reservation.CapacityCommitment]: + async def async_generator(): + async for page in self.pages: + for response in page.capacity_commitments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAssignmentsPager: + """A pager for iterating through ``list_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` + 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[..., reservation.ListAssignmentsResponse], + request: reservation.ListAssignmentsRequest, + response: reservation.ListAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.ListAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): + 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 = reservation.ListAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListAssignmentsResponse]: + 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[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAssignmentsAsyncPager: + """A pager for iterating through ``list_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` + 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[reservation.ListAssignmentsResponse]], + request: reservation.ListAssignmentsRequest, + response: reservation.ListAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.ListAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): + 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 = reservation.ListAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListAssignmentsResponse]: + 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[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAssignmentsPager: + """A pager for iterating through ``search_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` + 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[..., reservation.SearchAssignmentsResponse], + request: reservation.SearchAssignmentsRequest, + response: reservation.SearchAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.SearchAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): + 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 = reservation.SearchAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.SearchAssignmentsResponse]: + 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[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAssignmentsAsyncPager: + """A pager for iterating through ``search_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` + 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[reservation.SearchAssignmentsResponse]], + request: reservation.SearchAssignmentsRequest, + response: reservation.SearchAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.SearchAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): + 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 = reservation.SearchAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.SearchAssignmentsResponse]: + 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[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAllAssignmentsPager: + """A pager for iterating through ``search_all_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchAllAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` + 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[..., reservation.SearchAllAssignmentsResponse], + request: reservation.SearchAllAssignmentsRequest, + response: reservation.SearchAllAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): + 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 = reservation.SearchAllAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.SearchAllAssignmentsResponse]: + 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[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAllAssignmentsAsyncPager: + """A pager for iterating through ``search_all_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchAllAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` + 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[reservation.SearchAllAssignmentsResponse]], + request: reservation.SearchAllAssignmentsRequest, + response: reservation.SearchAllAssignmentsResponse, + *, + 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.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): + 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 = reservation.SearchAllAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.SearchAllAssignmentsResponse]: + 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[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + 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/bigquery_reservation_v1/services/reservation_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py new file mode 100644 index 00000000..4fadd3a7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import ReservationServiceTransport +from .grpc import ReservationServiceGrpcTransport +from .grpc_asyncio import ReservationServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[ReservationServiceTransport]] +_transport_registry['grpc'] = ReservationServiceGrpcTransport +_transport_registry['grpc_asyncio'] = ReservationServiceGrpcAsyncIOTransport + +__all__ = ( + 'ReservationServiceTransport', + 'ReservationServiceGrpcTransport', + 'ReservationServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py new file mode 100644 index 00000000..5276f0ed --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py @@ -0,0 +1,516 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.protobuf import empty_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-bigquery-reservation', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class ReservationServiceTransport(abc.ABC): + """Abstract transport class for ReservationService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'bigqueryreservation.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials 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 + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_reservation: gapic_v1.method.wrap_method( + self.create_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.list_reservations: gapic_v1.method.wrap_method( + self.list_reservations, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_reservation: gapic_v1.method.wrap_method( + self.get_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_reservation: gapic_v1.method.wrap_method( + self.delete_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_reservation: gapic_v1.method.wrap_method( + self.update_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.create_capacity_commitment: gapic_v1.method.wrap_method( + self.create_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_capacity_commitments: gapic_v1.method.wrap_method( + self.list_capacity_commitments, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_capacity_commitment: gapic_v1.method.wrap_method( + self.get_capacity_commitment, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_capacity_commitment: gapic_v1.method.wrap_method( + self.delete_capacity_commitment, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_capacity_commitment: gapic_v1.method.wrap_method( + self.update_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.split_capacity_commitment: gapic_v1.method.wrap_method( + self.split_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.merge_capacity_commitments: gapic_v1.method.wrap_method( + self.merge_capacity_commitments, + default_timeout=300.0, + client_info=client_info, + ), + self.create_assignment: gapic_v1.method.wrap_method( + self.create_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_assignments: gapic_v1.method.wrap_method( + self.list_assignments, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_assignment: gapic_v1.method.wrap_method( + self.delete_assignment, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.search_assignments: gapic_v1.method.wrap_method( + self.search_assignments, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.search_all_assignments: gapic_v1.method.wrap_method( + self.search_all_assignments, + default_timeout=None, + client_info=client_info, + ), + self.move_assignment: gapic_v1.method.wrap_method( + self.move_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.get_bi_reservation: gapic_v1.method.wrap_method( + self.get_bi_reservation, + 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=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_bi_reservation: gapic_v1.method.wrap_method( + self.update_bi_reservation, + default_timeout=300.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + Union[ + gcbr_reservation.Reservation, + Awaitable[gcbr_reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + Union[ + reservation.ListReservationsResponse, + Awaitable[reservation.ListReservationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + Union[ + reservation.Reservation, + Awaitable[reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + Union[ + gcbr_reservation.Reservation, + Awaitable[gcbr_reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + Union[ + reservation.ListCapacityCommitmentsResponse, + Awaitable[reservation.ListCapacityCommitmentsResponse] + ]]: + raise NotImplementedError() + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + Union[ + reservation.SplitCapacityCommitmentResponse, + Awaitable[reservation.SplitCapacityCommitmentResponse] + ]]: + raise NotImplementedError() + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + Union[ + reservation.Assignment, + Awaitable[reservation.Assignment] + ]]: + raise NotImplementedError() + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + Union[ + reservation.ListAssignmentsResponse, + Awaitable[reservation.ListAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + Union[ + reservation.SearchAssignmentsResponse, + Awaitable[reservation.SearchAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + Union[ + reservation.SearchAllAssignmentsResponse, + Awaitable[reservation.SearchAllAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + Union[ + reservation.Assignment, + Awaitable[reservation.Assignment] + ]]: + raise NotImplementedError() + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + Union[ + reservation.BiReservation, + Awaitable[reservation.BiReservation] + ]]: + raise NotImplementedError() + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + Union[ + reservation.BiReservation, + Awaitable[reservation.BiReservation] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'ReservationServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py new file mode 100644 index 00000000..ebe58756 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py @@ -0,0 +1,926 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.protobuf import empty_pb2 # type: ignore +from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO + + +class ReservationServiceGrpcTransport(ReservationServiceTransport): + """gRPC backend transport for ReservationService. + + This API allows users to manage their flat-rate BigQuery + reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + + 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 = 'bigqueryreservation.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'bigqueryreservation.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + gcbr_reservation.Reservation]: + r"""Return a callable for the create reservation method over gRPC. + + Creates a new reservation resource. + + Returns: + Callable[[~.CreateReservationRequest], + ~.Reservation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['create_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', + request_serializer=gcbr_reservation.CreateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['create_reservation'] + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + reservation.ListReservationsResponse]: + r"""Return a callable for the list reservations method over gRPC. + + Lists all the reservations for the project in the + specified location. + + Returns: + Callable[[~.ListReservationsRequest], + ~.ListReservationsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservations' not in self._stubs: + self._stubs['list_reservations'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', + request_serializer=reservation.ListReservationsRequest.serialize, + response_deserializer=reservation.ListReservationsResponse.deserialize, + ) + return self._stubs['list_reservations'] + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + reservation.Reservation]: + r"""Return a callable for the get reservation method over gRPC. + + Returns information about the reservation. + + Returns: + Callable[[~.GetReservationRequest], + ~.Reservation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['get_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', + request_serializer=reservation.GetReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['get_reservation'] + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete reservation method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationRequest], + ~.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_reservation' not in self._stubs: + self._stubs['delete_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', + request_serializer=reservation.DeleteReservationRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation'] + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + gcbr_reservation.Reservation]: + r"""Return a callable for the update reservation method over gRPC. + + Updates an existing reservation resource. + + Returns: + Callable[[~.UpdateReservationRequest], + ~.Reservation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['update_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', + request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['update_reservation'] + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the create capacity commitment method over gRPC. + + Creates a new capacity commitment resource. + + Returns: + Callable[[~.CreateCapacityCommitmentRequest], + ~.CapacityCommitment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['create_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', + request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['create_capacity_commitment'] + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + reservation.ListCapacityCommitmentsResponse]: + r"""Return a callable for the list capacity commitments method over gRPC. + + Lists all the capacity commitments for the admin + project. + + Returns: + Callable[[~.ListCapacityCommitmentsRequest], + ~.ListCapacityCommitmentsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitments' not in self._stubs: + self._stubs['list_capacity_commitments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', + request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, + ) + return self._stubs['list_capacity_commitments'] + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the get capacity commitment method over gRPC. + + Returns information about the capacity commitment. + + Returns: + Callable[[~.GetCapacityCommitmentRequest], + ~.CapacityCommitment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['get_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', + request_serializer=reservation.GetCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['get_capacity_commitment'] + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete capacity commitment method over gRPC. + + Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.DeleteCapacityCommitmentRequest], + ~.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_capacity_commitment' not in self._stubs: + self._stubs['delete_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', + request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_capacity_commitment'] + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the update capacity commitment method over gRPC. + + Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.UpdateCapacityCommitmentRequest], + ~.CapacityCommitment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['update_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', + request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['update_capacity_commitment'] + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + reservation.SplitCapacityCommitmentResponse]: + r"""Return a callable for the split capacity commitment method over gRPC. + + Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you would change the plan of the first one to + ``FLEX`` and then delete it. + + Returns: + Callable[[~.SplitCapacityCommitmentRequest], + ~.SplitCapacityCommitmentResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'split_capacity_commitment' not in self._stubs: + self._stubs['split_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', + request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, + response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, + ) + return self._stubs['split_capacity_commitment'] + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the merge capacity commitments method over gRPC. + + Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.MergeCapacityCommitmentsRequest], + ~.CapacityCommitment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'merge_capacity_commitments' not in self._stubs: + self._stubs['merge_capacity_commitments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', + request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['merge_capacity_commitments'] + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + reservation.Assignment]: + r"""Return a callable for the create assignment method over gRPC. + + Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Returns: + Callable[[~.CreateAssignmentRequest], + ~.Assignment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_assignment' not in self._stubs: + self._stubs['create_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', + request_serializer=reservation.CreateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['create_assignment'] + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + reservation.ListAssignmentsResponse]: + r"""Return a callable for the list assignments method over gRPC. + + Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.ListAssignmentsRequest], + ~.ListAssignmentsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_assignments' not in self._stubs: + self._stubs['list_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', + request_serializer=reservation.ListAssignmentsRequest.serialize, + response_deserializer=reservation.ListAssignmentsResponse.deserialize, + ) + return self._stubs['list_assignments'] + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete assignment method over gRPC. + + Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Returns: + Callable[[~.DeleteAssignmentRequest], + ~.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_assignment' not in self._stubs: + self._stubs['delete_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', + request_serializer=reservation.DeleteAssignmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_assignment'] + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + reservation.SearchAssignmentsResponse]: + r"""Return a callable for the search assignments method over gRPC. + + Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.SearchAssignmentsRequest], + ~.SearchAssignmentsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_assignments' not in self._stubs: + self._stubs['search_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', + request_serializer=reservation.SearchAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAssignmentsResponse.deserialize, + ) + return self._stubs['search_assignments'] + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + reservation.SearchAllAssignmentsResponse]: + r"""Return a callable for the search all assignments method over gRPC. + + Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Returns: + Callable[[~.SearchAllAssignmentsRequest], + ~.SearchAllAssignmentsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_all_assignments' not in self._stubs: + self._stubs['search_all_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', + request_serializer=reservation.SearchAllAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, + ) + return self._stubs['search_all_assignments'] + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + reservation.Assignment]: + r"""Return a callable for the move assignment method over gRPC. + + Moves an assignment under a new reservation. + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Returns: + Callable[[~.MoveAssignmentRequest], + ~.Assignment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'move_assignment' not in self._stubs: + self._stubs['move_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', + request_serializer=reservation.MoveAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['move_assignment'] + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + reservation.BiReservation]: + r"""Return a callable for the get bi reservation method over gRPC. + + Retrieves a BI reservation. + + Returns: + Callable[[~.GetBiReservationRequest], + ~.BiReservation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: + self._stubs['get_bi_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', + request_serializer=reservation.GetBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['get_bi_reservation'] + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + reservation.BiReservation]: + r"""Return a callable for the update bi reservation method over gRPC. + + Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Returns: + Callable[[~.UpdateBiReservationRequest], + ~.BiReservation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: + self._stubs['update_bi_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', + request_serializer=reservation.UpdateBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['update_bi_reservation'] + + def close(self): + self.grpc_channel.close() + +__all__ = ( + 'ReservationServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py new file mode 100644 index 00000000..10dd8d1b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py @@ -0,0 +1,931 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.protobuf import empty_pb2 # type: ignore +from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import ReservationServiceGrpcTransport + + +class ReservationServiceGrpcAsyncIOTransport(ReservationServiceTransport): + """gRPC AsyncIO backend transport for ReservationService. + + This API allows users to manage their flat-rate BigQuery + reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + + 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 = 'bigqueryreservation.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'bigqueryreservation.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + Awaitable[gcbr_reservation.Reservation]]: + r"""Return a callable for the create reservation method over gRPC. + + Creates a new reservation resource. + + Returns: + Callable[[~.CreateReservationRequest], + Awaitable[~.Reservation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['create_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', + request_serializer=gcbr_reservation.CreateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['create_reservation'] + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + Awaitable[reservation.ListReservationsResponse]]: + r"""Return a callable for the list reservations method over gRPC. + + Lists all the reservations for the project in the + specified location. + + Returns: + Callable[[~.ListReservationsRequest], + Awaitable[~.ListReservationsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservations' not in self._stubs: + self._stubs['list_reservations'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', + request_serializer=reservation.ListReservationsRequest.serialize, + response_deserializer=reservation.ListReservationsResponse.deserialize, + ) + return self._stubs['list_reservations'] + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + Awaitable[reservation.Reservation]]: + r"""Return a callable for the get reservation method over gRPC. + + Returns information about the reservation. + + Returns: + Callable[[~.GetReservationRequest], + Awaitable[~.Reservation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['get_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', + request_serializer=reservation.GetReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['get_reservation'] + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete reservation method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationRequest], + 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_reservation' not in self._stubs: + self._stubs['delete_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', + request_serializer=reservation.DeleteReservationRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation'] + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + Awaitable[gcbr_reservation.Reservation]]: + r"""Return a callable for the update reservation method over gRPC. + + Updates an existing reservation resource. + + Returns: + Callable[[~.UpdateReservationRequest], + Awaitable[~.Reservation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_reservation' not in self._stubs: + self._stubs['update_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', + request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['update_reservation'] + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the create capacity commitment method over gRPC. + + Creates a new capacity commitment resource. + + Returns: + Callable[[~.CreateCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['create_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', + request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['create_capacity_commitment'] + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + Awaitable[reservation.ListCapacityCommitmentsResponse]]: + r"""Return a callable for the list capacity commitments method over gRPC. + + Lists all the capacity commitments for the admin + project. + + Returns: + Callable[[~.ListCapacityCommitmentsRequest], + Awaitable[~.ListCapacityCommitmentsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitments' not in self._stubs: + self._stubs['list_capacity_commitments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', + request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, + ) + return self._stubs['list_capacity_commitments'] + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the get capacity commitment method over gRPC. + + Returns information about the capacity commitment. + + Returns: + Callable[[~.GetCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['get_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', + request_serializer=reservation.GetCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['get_capacity_commitment'] + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete capacity commitment method over gRPC. + + Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.DeleteCapacityCommitmentRequest], + 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_capacity_commitment' not in self._stubs: + self._stubs['delete_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', + request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_capacity_commitment'] + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the update capacity commitment method over gRPC. + + Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.UpdateCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: + self._stubs['update_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', + request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['update_capacity_commitment'] + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + Awaitable[reservation.SplitCapacityCommitmentResponse]]: + r"""Return a callable for the split capacity commitment method over gRPC. + + Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you would change the plan of the first one to + ``FLEX`` and then delete it. + + Returns: + Callable[[~.SplitCapacityCommitmentRequest], + Awaitable[~.SplitCapacityCommitmentResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'split_capacity_commitment' not in self._stubs: + self._stubs['split_capacity_commitment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', + request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, + response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, + ) + return self._stubs['split_capacity_commitment'] + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the merge capacity commitments method over gRPC. + + Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.MergeCapacityCommitmentsRequest], + Awaitable[~.CapacityCommitment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'merge_capacity_commitments' not in self._stubs: + self._stubs['merge_capacity_commitments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', + request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['merge_capacity_commitments'] + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + Awaitable[reservation.Assignment]]: + r"""Return a callable for the create assignment method over gRPC. + + Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Returns: + Callable[[~.CreateAssignmentRequest], + Awaitable[~.Assignment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_assignment' not in self._stubs: + self._stubs['create_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', + request_serializer=reservation.CreateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['create_assignment'] + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + Awaitable[reservation.ListAssignmentsResponse]]: + r"""Return a callable for the list assignments method over gRPC. + + Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.ListAssignmentsRequest], + Awaitable[~.ListAssignmentsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_assignments' not in self._stubs: + self._stubs['list_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', + request_serializer=reservation.ListAssignmentsRequest.serialize, + response_deserializer=reservation.ListAssignmentsResponse.deserialize, + ) + return self._stubs['list_assignments'] + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete assignment method over gRPC. + + Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Returns: + Callable[[~.DeleteAssignmentRequest], + 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_assignment' not in self._stubs: + self._stubs['delete_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', + request_serializer=reservation.DeleteAssignmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_assignment'] + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + Awaitable[reservation.SearchAssignmentsResponse]]: + r"""Return a callable for the search assignments method over gRPC. + + Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.SearchAssignmentsRequest], + Awaitable[~.SearchAssignmentsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_assignments' not in self._stubs: + self._stubs['search_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', + request_serializer=reservation.SearchAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAssignmentsResponse.deserialize, + ) + return self._stubs['search_assignments'] + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + Awaitable[reservation.SearchAllAssignmentsResponse]]: + r"""Return a callable for the search all assignments method over gRPC. + + Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Returns: + Callable[[~.SearchAllAssignmentsRequest], + Awaitable[~.SearchAllAssignmentsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_all_assignments' not in self._stubs: + self._stubs['search_all_assignments'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', + request_serializer=reservation.SearchAllAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, + ) + return self._stubs['search_all_assignments'] + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + Awaitable[reservation.Assignment]]: + r"""Return a callable for the move assignment method over gRPC. + + Moves an assignment under a new reservation. + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Returns: + Callable[[~.MoveAssignmentRequest], + Awaitable[~.Assignment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'move_assignment' not in self._stubs: + self._stubs['move_assignment'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', + request_serializer=reservation.MoveAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['move_assignment'] + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + Awaitable[reservation.BiReservation]]: + r"""Return a callable for the get bi reservation method over gRPC. + + Retrieves a BI reservation. + + Returns: + Callable[[~.GetBiReservationRequest], + Awaitable[~.BiReservation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: + self._stubs['get_bi_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', + request_serializer=reservation.GetBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['get_bi_reservation'] + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + Awaitable[reservation.BiReservation]]: + r"""Return a callable for the update bi reservation method over gRPC. + + Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Returns: + Callable[[~.UpdateBiReservationRequest], + Awaitable[~.BiReservation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: + self._stubs['update_bi_reservation'] = self.grpc_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', + request_serializer=reservation.UpdateBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['update_bi_reservation'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'ReservationServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py new file mode 100644 index 00000000..34a4a055 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .reservation import ( + Assignment, + BiReservation, + CapacityCommitment, + CreateAssignmentRequest, + CreateCapacityCommitmentRequest, + CreateReservationRequest, + DeleteAssignmentRequest, + DeleteCapacityCommitmentRequest, + DeleteReservationRequest, + GetBiReservationRequest, + GetCapacityCommitmentRequest, + GetReservationRequest, + ListAssignmentsRequest, + ListAssignmentsResponse, + ListCapacityCommitmentsRequest, + ListCapacityCommitmentsResponse, + ListReservationsRequest, + ListReservationsResponse, + MergeCapacityCommitmentsRequest, + MoveAssignmentRequest, + Reservation, + SearchAllAssignmentsRequest, + SearchAllAssignmentsResponse, + SearchAssignmentsRequest, + SearchAssignmentsResponse, + SplitCapacityCommitmentRequest, + SplitCapacityCommitmentResponse, + UpdateBiReservationRequest, + UpdateCapacityCommitmentRequest, + UpdateReservationRequest, +) + +__all__ = ( + 'Assignment', + 'BiReservation', + 'CapacityCommitment', + 'CreateAssignmentRequest', + 'CreateCapacityCommitmentRequest', + 'CreateReservationRequest', + 'DeleteAssignmentRequest', + 'DeleteCapacityCommitmentRequest', + 'DeleteReservationRequest', + 'GetBiReservationRequest', + 'GetCapacityCommitmentRequest', + 'GetReservationRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'MergeCapacityCommitmentsRequest', + 'MoveAssignmentRequest', + 'Reservation', + 'SearchAllAssignmentsRequest', + 'SearchAllAssignmentsResponse', + 'SearchAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'UpdateBiReservationRequest', + 'UpdateCapacityCommitmentRequest', + 'UpdateReservationRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py new file mode 100644 index 00000000..f6190c89 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py @@ -0,0 +1,1023 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.bigquery.reservation.v1', + manifest={ + 'Reservation', + 'CapacityCommitment', + 'CreateReservationRequest', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'GetReservationRequest', + 'DeleteReservationRequest', + 'UpdateReservationRequest', + 'CreateCapacityCommitmentRequest', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'GetCapacityCommitmentRequest', + 'DeleteCapacityCommitmentRequest', + 'UpdateCapacityCommitmentRequest', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'MergeCapacityCommitmentsRequest', + 'Assignment', + 'CreateAssignmentRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'DeleteAssignmentRequest', + 'SearchAssignmentsRequest', + 'SearchAllAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SearchAllAssignmentsResponse', + 'MoveAssignmentRequest', + 'BiReservation', + 'GetBiReservationRequest', + 'UpdateBiReservationRequest', + }, +) + + +class Reservation(proto.Message): + r"""A reservation is a mechanism used to guarantee slots to + users. + + Attributes: + name (str): + The resource name of the reservation, e.g., + ``projects/*/locations/*/reservations/team1-prod``. + slot_capacity (int): + Minimum slots available to this reservation. A slot is a + unit of computational power in BigQuery, and serves as the + unit of parallelism. + + Queries using this reservation might use more slots during + runtime if ignore_idle_slots is set to false. + + If the new reservation's slot capacity exceed the parent's + slot capacity or if total slot capacity of the new + reservation and its siblings exceeds the parent's slot + capacity, the request will fail with + ``google.rpc.Code.RESOURCE_EXHAUSTED``. + ignore_idle_slots (bool): + If false, any query or pipeline job using this reservation + will use idle slots from other reservations within the same + admin project. If true, a query or pipeline job using this + reservation will execute with the slot capacity specified in + the slot_capacity field at most. + creation_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time of the + reservation. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Last update time of the + reservation. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + slot_capacity = proto.Field( + proto.INT64, + number=2, + ) + ignore_idle_slots = proto.Field( + proto.BOOL, + number=4, + ) + creation_time = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + + +class CapacityCommitment(proto.Message): + r"""Capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period + of usage. Annual commitments renew by default. Commitments can + be removed after their commitment end time passes. + + In order to remove annual commitment, its plan needs to be + changed to monthly or flex first. + + A capacity commitment resource exists as a child resource of the + admin project. + + Attributes: + name (str): + Output only. The resource name of the capacity commitment, + e.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + slot_count (int): + Number of slots in this commitment. + plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): + Capacity commitment commitment plan. + state (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State): + Output only. State of the commitment. + commitment_start_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The start of the current + commitment period. It is applicable only for + ACTIVE capacity commitments. + commitment_end_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The end of the current + commitment period. It is applicable only for + ACTIVE capacity commitments. + failure_status (google.rpc.status_pb2.Status): + Output only. For FAILED commitment plan, + provides the reason of failure. + renewal_plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): + The plan this capacity commitment is converted to after + commitment_end_time passes. Once the plan is changed, + committed period is extended according to commitment plan. + Only applicable for ANNUAL and TRIAL commitments. + """ + class CommitmentPlan(proto.Enum): + r"""Commitment plan defines the current committed period. + Capacity commitment cannot be deleted during it's committed + period. + """ + COMMITMENT_PLAN_UNSPECIFIED = 0 + FLEX = 3 + TRIAL = 5 + MONTHLY = 2 + ANNUAL = 4 + + class State(proto.Enum): + r"""Capacity commitment can either become ACTIVE right away or + transition from PENDING to ACTIVE or FAILED. + """ + STATE_UNSPECIFIED = 0 + PENDING = 1 + ACTIVE = 2 + FAILED = 3 + + name = proto.Field( + proto.STRING, + number=1, + ) + slot_count = proto.Field( + proto.INT64, + number=2, + ) + plan = proto.Field( + proto.ENUM, + number=3, + enum=CommitmentPlan, + ) + state = proto.Field( + proto.ENUM, + number=4, + enum=State, + ) + commitment_start_time = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + commitment_end_time = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + failure_status = proto.Field( + proto.MESSAGE, + number=7, + message=status_pb2.Status, + ) + renewal_plan = proto.Field( + proto.ENUM, + number=8, + enum=CommitmentPlan, + ) + + +class CreateReservationRequest(proto.Message): + r"""The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + + Attributes: + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + reservation_id (str): + The reservation ID. This field must only + contain lower case alphanumeric characters or + dash. Max length is 64 characters. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Definition of the new reservation to create. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + reservation_id = proto.Field( + proto.STRING, + number=2, + ) + reservation = proto.Field( + proto.MESSAGE, + number=3, + message='Reservation', + ) + + +class ListReservationsRequest(proto.Message): + r"""The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Attributes: + parent (str): + Required. The parent resource name containing project and + location, e.g.: ``projects/myproject/locations/US`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListReservationsResponse(proto.Message): + r"""The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Attributes: + reservations (Sequence[google.cloud.bigquery_reservation_v1.types.Reservation]): + List of reservations visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + reservations = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Reservation', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetReservationRequest(proto.Message): + r"""The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + + Attributes: + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteReservationRequest(proto.Message): + r"""The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + + Attributes: + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateReservationRequest(proto.Message): + r"""The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + + Attributes: + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Content of the reservation to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of fields to + be updated. + """ + + reservation = proto.Field( + proto.MESSAGE, + number=1, + message='Reservation', + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class CreateCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + + Attributes: + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to create. + enforce_single_admin_project_per_org (bool): + If true, fail the request if another project + in the organization has a capacity commitment. + capacity_commitment_id (str): + The optional capacity commitment ID. Capacity + commitment name will be generated automatically + if this field is empty. This field must only + contain lower case alphanumeric characters or + dash. Max length is 64 characters. + NOTE: this ID won't be kept if the capacity + commitment is split or merged. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + capacity_commitment = proto.Field( + proto.MESSAGE, + number=2, + message='CapacityCommitment', + ) + enforce_single_admin_project_per_org = proto.Field( + proto.BOOL, + number=4, + ) + capacity_commitment_id = proto.Field( + proto.STRING, + number=5, + ) + + +class ListCapacityCommitmentsRequest(proto.Message): + r"""The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Attributes: + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListCapacityCommitmentsResponse(proto.Message): + r"""The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Attributes: + capacity_commitments (Sequence[google.cloud.bigquery_reservation_v1.types.CapacityCommitment]): + List of capacity commitments visible to the + user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + capacity_commitments = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + + Attributes: + name (str): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + + Attributes: + name (str): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + force (bool): + Can be used to force delete commitments even + if assignments exist. Deleting commitments with + assignments may cause queries to fail if they no + longer have access to slots. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + force = proto.Field( + proto.BOOL, + number=3, + ) + + +class UpdateCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + + Attributes: + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of fields to + be updated. + """ + + capacity_commitment = proto.Field( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class SplitCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + Attributes: + name (str): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + slot_count (int): + Number of slots in the capacity commitment + after the split. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + slot_count = proto.Field( + proto.INT64, + number=2, + ) + + +class SplitCapacityCommitmentResponse(proto.Message): + r"""The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + Attributes: + first (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + First capacity commitment, result of a split. + second (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Second capacity commitment, result of a + split. + """ + + first = proto.Field( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + second = proto.Field( + proto.MESSAGE, + number=2, + message='CapacityCommitment', + ) + + +class MergeCapacityCommitmentsRequest(proto.Message): + r"""The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + + Attributes: + parent (str): + Parent resource that identifies admin project and location + e.g., ``projects/myproject/locations/us`` + capacity_commitment_ids (Sequence[str]): + Ids of capacity commitments to merge. + These capacity commitments must exist under + admin project and location specified in the + parent. + ID is the last portion of capacity commitment + name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + capacity_commitment_ids = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class Assignment(proto.Message): + r"""A Assignment allows a project to submit jobs + of a certain type using slots from the specified reservation. + + Attributes: + name (str): + Output only. Name of the resource. E.g.: + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123``. + assignee (str): + The resource which will use the reservation. E.g. + ``projects/myproject``, ``folders/123``, or + ``organizations/456``. + job_type (google.cloud.bigquery_reservation_v1.types.Assignment.JobType): + Which type of jobs will use the reservation. + state (google.cloud.bigquery_reservation_v1.types.Assignment.State): + Output only. State of the assignment. + """ + class JobType(proto.Enum): + r"""Types of job, which could be specified when using the + reservation. + """ + JOB_TYPE_UNSPECIFIED = 0 + PIPELINE = 1 + QUERY = 2 + ML_EXTERNAL = 3 + + class State(proto.Enum): + r"""Assignment will remain in PENDING state if no active capacity + commitment is present. It will become ACTIVE when some capacity + commitment becomes active. + """ + STATE_UNSPECIFIED = 0 + PENDING = 1 + ACTIVE = 2 + + name = proto.Field( + proto.STRING, + number=1, + ) + assignee = proto.Field( + proto.STRING, + number=4, + ) + job_type = proto.Field( + proto.ENUM, + number=3, + enum=JobType, + ) + state = proto.Field( + proto.ENUM, + number=6, + enum=State, + ) + + +class CreateAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The parent resource name of the assignment E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Assignment resource to create. + assignment_id (str): + The optional assignment ID. Assignment name + will be generated automatically if this field is + empty. This field must only contain lower case + alphanumeric characters or dash. Max length is + 64 characters. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + assignment = proto.Field( + proto.MESSAGE, + number=2, + message='Assignment', + ) + assignment_id = proto.Field( + proto.STRING, + number=4, + ) + + +class ListAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Attributes: + parent (str): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Attributes: + assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" permission is + required on the related assignee. + + Attributes: + name (str): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class SearchAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The resource name of the admin project(containing + project and location), e.g.: + ``projects/myproject/locations/US``. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + query = proto.Field( + proto.STRING, + number=2, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchAllAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + query = proto.Field( + proto.STRING, + number=2, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Attributes: + assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchAllAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + Attributes: + assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class MoveAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" permission is + required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are required on + the related assignee. + + Attributes: + name (str): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + destination_id (str): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + destination_id = proto.Field( + proto.STRING, + number=3, + ) + + +class BiReservation(proto.Message): + r"""Represents a BI Reservation. + + Attributes: + name (str): + The resource name of the singleton BI reservation. + Reservation names have the form + ``projects/{project_id}/locations/{location_id}/biReservation``. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The last update timestamp of a + reservation. + size (int): + Size of a reservation, in bytes. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + size = proto.Field( + proto.INT64, + number=4, + ) + + +class GetBiReservationRequest(proto.Message): + r"""A request to get a singleton BI reservation. + + Attributes: + name (str): + Required. Name of the requested reservation, for example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateBiReservationRequest(proto.Message): + r"""A request to update a BI reservation. + + Attributes: + bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): + A reservation to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + A list of fields to be updated in this + request. + """ + + bi_reservation = proto.Field( + proto.MESSAGE, + number=1, + message='BiReservation', + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +__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..4505b485 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 00000000..0fae27af --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/bigquery_reservation_v1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py new file mode 100644 index 00000000..c7cb6030 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py @@ -0,0 +1,195 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class bigquery_reservationCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_assignment': ('parent', 'assignment', 'assignment_id', ), + 'create_capacity_commitment': ('parent', 'capacity_commitment', 'enforce_single_admin_project_per_org', 'capacity_commitment_id', ), + 'create_reservation': ('parent', 'reservation_id', 'reservation', ), + 'delete_assignment': ('name', ), + 'delete_capacity_commitment': ('name', 'force', ), + 'delete_reservation': ('name', ), + 'get_bi_reservation': ('name', ), + 'get_capacity_commitment': ('name', ), + 'get_reservation': ('name', ), + 'list_assignments': ('parent', 'page_size', 'page_token', ), + 'list_capacity_commitments': ('parent', 'page_size', 'page_token', ), + 'list_reservations': ('parent', 'page_size', 'page_token', ), + 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', ), + 'move_assignment': ('name', 'destination_id', ), + 'search_all_assignments': ('parent', 'query', 'page_size', 'page_token', ), + 'search_assignments': ('parent', 'query', 'page_size', 'page_token', ), + 'split_capacity_commitment': ('name', 'slot_count', ), + 'update_bi_reservation': ('bi_reservation', 'update_mask', ), + 'update_capacity_commitment': ('capacity_commitment', 'update_mask', ), + 'update_reservation': ('reservation', '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=bigquery_reservationCallTransformer(), +): + """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 bigquery_reservation 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..332ecf4f --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-bigquery-reservation', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py new file mode 100644 index 00000000..683f204c --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py @@ -0,0 +1,6795 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceAsyncClient +from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceClient +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.services.reservation_service import transports +from google.cloud.bigquery_reservation_v1.services.reservation_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.oauth2 import service_account +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert ReservationServiceClient._get_default_mtls_endpoint(None) is None + assert ReservationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + ReservationServiceClient, + ReservationServiceAsyncClient, +]) +def test_reservation_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'bigqueryreservation.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.ReservationServiceGrpcTransport, "grpc"), + (transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_reservation_service_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + ReservationServiceClient, + ReservationServiceAsyncClient, +]) +def test_reservation_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'bigqueryreservation.googleapis.com:443' + + +def test_reservation_service_client_get_transport_class(): + transport = ReservationServiceClient.get_transport_class() + available_transports = [ + transports.ReservationServiceGrpcTransport, + ] + assert transport in available_transports + + transport = ReservationServiceClient.get_transport_class("grpc") + assert transport == transports.ReservationServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) +def test_reservation_service_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(ReservationServiceClient, '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(ReservationServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "true"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "false"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_reservation_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_reservation_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_reservation_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_reservation_service_client_client_options_from_dict(): + with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = ReservationServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_create_reservation(transport: str = 'grpc', request_type=gcbr_reservation.CreateReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + ) + response = client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.CreateReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +def test_create_reservation_from_dict(): + test_create_reservation(request_type=dict) + + +def test_create_reservation_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 = ReservationServiceClient( + 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_reservation), + '__call__') as call: + client.create_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.CreateReservationRequest() + + +@pytest.mark.asyncio +async def test_create_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.CreateReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + )) + response = await client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.CreateReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +@pytest.mark.asyncio +async def test_create_reservation_async_from_dict(): + await test_create_reservation_async(request_type=dict) + + +def test_create_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcbr_reservation.CreateReservationRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.create_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcbr_reservation.CreateReservationRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + await client.create_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_reservation( + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') + assert args[0].reservation_id == 'reservation_id_value' + + +def test_create_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.CreateReservationRequest(), + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_reservation( + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') + assert args[0].reservation_id == 'reservation_id_value' + + +@pytest.mark.asyncio +async def test_create_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_reservation( + gcbr_reservation.CreateReservationRequest(), + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + +def test_list_reservations(transport: str = 'grpc', request_type=reservation.ListReservationsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_reservations_from_dict(): + test_list_reservations(request_type=dict) + + +def test_list_reservations_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 = ReservationServiceClient( + 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_reservations), + '__call__') as call: + client.list_reservations() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationsRequest() + + +@pytest.mark.asyncio +async def test_list_reservations_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_reservations_async_from_dict(): + await test_list_reservations_async(request_type=dict) + + +def test_list_reservations_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListReservationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value = reservation.ListReservationsResponse() + client.list_reservations(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_reservations_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListReservationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) + await client.list_reservations(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_reservations_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_reservations( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_reservations_flattened_error(): + client = ReservationServiceClient( + 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_reservations( + reservation.ListReservationsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_reservations_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_reservations( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_reservations_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_reservations( + reservation.ListReservationsRequest(), + parent='parent_value', + ) + + +def test_list_reservations_pager(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_reservations(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, reservation.Reservation) + for i in results) + +def test_list_reservations_pages(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + pages = list(client.list_reservations(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_reservations_async_pager(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_reservations(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reservation.Reservation) + for i in responses) + +@pytest.mark.asyncio +async def test_list_reservations_async_pages(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_reservations(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_reservation(transport: str = 'grpc', request_type=reservation.GetReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + ) + response = client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +def test_get_reservation_from_dict(): + test_get_reservation(request_type=dict) + + +def test_get_reservation_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 = ReservationServiceClient( + 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_reservation), + '__call__') as call: + client.get_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationRequest() + + +@pytest.mark.asyncio +async def test_get_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + )) + response = await client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +@pytest.mark.asyncio +async def test_get_reservation_async_from_dict(): + await test_get_reservation_async(request_type=dict) + + +def test_get_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value = reservation.Reservation() + client.get_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) + await client.get_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + reservation.GetReservationRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_reservation( + reservation.GetReservationRequest(), + name='name_value', + ) + + +def test_delete_reservation(transport: str = 'grpc', request_type=reservation.DeleteReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reservation_from_dict(): + test_delete_reservation(request_type=dict) + + +def test_delete_reservation_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 = ReservationServiceClient( + 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_reservation), + '__call__') as call: + client.delete_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationRequest() + + +@pytest.mark.asyncio +async def test_delete_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_reservation_async_from_dict(): + await test_delete_reservation_async(request_type=dict) + + +def test_delete_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value = None + client.delete_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__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_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + reservation.DeleteReservationRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__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_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_reservation( + reservation.DeleteReservationRequest(), + name='name_value', + ) + + +def test_update_reservation(transport: str = 'grpc', request_type=gcbr_reservation.UpdateReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + ) + response = client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.UpdateReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +def test_update_reservation_from_dict(): + test_update_reservation(request_type=dict) + + +def test_update_reservation_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 = ReservationServiceClient( + 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_reservation), + '__call__') as call: + client.update_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.UpdateReservationRequest() + + +@pytest.mark.asyncio +async def test_update_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.UpdateReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + )) + response = await client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.UpdateReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + + +@pytest.mark.asyncio +async def test_update_reservation_async_from_dict(): + await test_update_reservation_async(request_type=dict) + + +def test_update_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcbr_reservation.UpdateReservationRequest() + + request.reservation.name = 'reservation.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.update_reservation(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', + 'reservation.name=reservation.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcbr_reservation.UpdateReservationRequest() + + request.reservation.name = 'reservation.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + await client.update_reservation(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', + 'reservation.name=reservation.name/value', + ) in kw['metadata'] + + +def test_update_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_reservation( + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_reservation( + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_create_capacity_commitment(transport: str = 'grpc', request_type=reservation.CreateCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + ) + response = client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +def test_create_capacity_commitment_from_dict(): + test_create_capacity_commitment(request_type=dict) + + +def test_create_capacity_commitment_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 = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + client.create_capacity_commitment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateCapacityCommitmentRequest() + + +@pytest.mark.asyncio +async def test_create_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + )) + response = await client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +@pytest.mark.asyncio +async def test_create_capacity_commitment_async_from_dict(): + await test_create_capacity_commitment_async(request_type=dict) + + +def test_create_capacity_commitment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.CreateCapacityCommitmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.create_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.CreateCapacityCommitmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.create_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_capacity_commitment( + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') + + +def test_create_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + +@pytest.mark.asyncio +async def test_create_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_capacity_commitment( + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') + + +@pytest.mark.asyncio +async def test_create_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + +def test_list_capacity_commitments(transport: str = 'grpc', request_type=reservation.ListCapacityCommitmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListCapacityCommitmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCapacityCommitmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_capacity_commitments_from_dict(): + test_list_capacity_commitments(request_type=dict) + + +def test_list_capacity_commitments_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 = ReservationServiceClient( + 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_capacity_commitments), + '__call__') as call: + client.list_capacity_commitments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListCapacityCommitmentsRequest() + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListCapacityCommitmentsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListCapacityCommitmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCapacityCommitmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async_from_dict(): + await test_list_capacity_commitments_async(request_type=dict) + + +def test_list_capacity_commitments_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListCapacityCommitmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value = reservation.ListCapacityCommitmentsResponse() + client.list_capacity_commitments(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_capacity_commitments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListCapacityCommitmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) + await client.list_capacity_commitments(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_capacity_commitments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_capacity_commitments( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_capacity_commitments_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_capacity_commitments( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), + parent='parent_value', + ) + + +def test_list_capacity_commitments_pager(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_capacity_commitments(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, reservation.CapacityCommitment) + for i in results) + +def test_list_capacity_commitments_pages(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_capacity_commitments(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_capacity_commitments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_capacity_commitments(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reservation.CapacityCommitment) + for i in responses) + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_capacity_commitments(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_capacity_commitment(transport: str = 'grpc', request_type=reservation.GetCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + ) + response = client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +def test_get_capacity_commitment_from_dict(): + test_get_capacity_commitment(request_type=dict) + + +def test_get_capacity_commitment_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 = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + client.get_capacity_commitment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetCapacityCommitmentRequest() + + +@pytest.mark.asyncio +async def test_get_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.GetCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + )) + response = await client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +@pytest.mark.asyncio +async def test_get_capacity_commitment_async_from_dict(): + await test_get_capacity_commitment_async(request_type=dict) + + +def test_get_capacity_commitment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.get_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.get_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_capacity_commitment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_capacity_commitment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), + name='name_value', + ) + + +def test_delete_capacity_commitment(transport: str = 'grpc', request_type=reservation.DeleteCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_capacity_commitment_from_dict(): + test_delete_capacity_commitment(request_type=dict) + + +def test_delete_capacity_commitment_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 = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + client.delete_capacity_commitment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteCapacityCommitmentRequest() + + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_async_from_dict(): + await test_delete_capacity_commitment_async(request_type=dict) + + +def test_delete_capacity_commitment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value = None + client.delete_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__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_capacity_commitment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__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_capacity_commitment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name='name_value', + ) + + +def test_update_capacity_commitment(transport: str = 'grpc', request_type=reservation.UpdateCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + ) + response = client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +def test_update_capacity_commitment_from_dict(): + test_update_capacity_commitment(request_type=dict) + + +def test_update_capacity_commitment_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 = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + client.update_capacity_commitment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateCapacityCommitmentRequest() + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + )) + response = await client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_async_from_dict(): + await test_update_capacity_commitment_async(request_type=dict) + + +def test_update_capacity_commitment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.UpdateCapacityCommitmentRequest() + + request.capacity_commitment.name = 'capacity_commitment.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.update_capacity_commitment(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', + 'capacity_commitment.name=capacity_commitment.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.UpdateCapacityCommitmentRequest() + + request.capacity_commitment.name = 'capacity_commitment.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.update_capacity_commitment(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', + 'capacity_commitment.name=capacity_commitment.name/value', + ) in kw['metadata'] + + +def test_update_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_capacity_commitment( + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_capacity_commitment( + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_split_capacity_commitment(transport: str = 'grpc', request_type=reservation.SplitCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse( + ) + response = client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SplitCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + + +def test_split_capacity_commitment_from_dict(): + test_split_capacity_commitment(request_type=dict) + + +def test_split_capacity_commitment_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 = ReservationServiceClient( + 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.split_capacity_commitment), + '__call__') as call: + client.split_capacity_commitment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SplitCapacityCommitmentRequest() + + +@pytest.mark.asyncio +async def test_split_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.SplitCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( + )) + response = await client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SplitCapacityCommitmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + + +@pytest.mark.asyncio +async def test_split_capacity_commitment_async_from_dict(): + await test_split_capacity_commitment_async(request_type=dict) + + +def test_split_capacity_commitment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SplitCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value = reservation.SplitCapacityCommitmentResponse() + client.split_capacity_commitment(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_split_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SplitCapacityCommitmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) + await client.split_capacity_commitment(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_split_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.split_capacity_commitment( + name='name_value', + slot_count=1098, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].slot_count == 1098 + + +def test_split_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), + name='name_value', + slot_count=1098, + ) + + +@pytest.mark.asyncio +async def test_split_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.split_capacity_commitment( + name='name_value', + slot_count=1098, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].slot_count == 1098 + + +@pytest.mark.asyncio +async def test_split_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), + name='name_value', + slot_count=1098, + ) + + +def test_merge_capacity_commitments(transport: str = 'grpc', request_type=reservation.MergeCapacityCommitmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + ) + response = client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MergeCapacityCommitmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +def test_merge_capacity_commitments_from_dict(): + test_merge_capacity_commitments(request_type=dict) + + +def test_merge_capacity_commitments_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 = ReservationServiceClient( + 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.merge_capacity_commitments), + '__call__') as call: + client.merge_capacity_commitments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MergeCapacityCommitmentsRequest() + + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.MergeCapacityCommitmentsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + )) + response = await client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MergeCapacityCommitmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_async_from_dict(): + await test_merge_capacity_commitments_async(request_type=dict) + + +def test_merge_capacity_commitments_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.MergeCapacityCommitmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.merge_capacity_commitments(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_merge_capacity_commitments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.MergeCapacityCommitmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.merge_capacity_commitments(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_merge_capacity_commitments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.merge_capacity_commitments( + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].capacity_commitment_ids == ['capacity_commitment_ids_value'] + + +def test_merge_capacity_commitments_flattened_error(): + client = ReservationServiceClient( + 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.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.merge_capacity_commitments( + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].capacity_commitment_ids == ['capacity_commitment_ids_value'] + + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + +def test_create_assignment(transport: str = 'grpc', request_type=reservation.CreateAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + ) + response = client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + + +def test_create_assignment_from_dict(): + test_create_assignment(request_type=dict) + + +def test_create_assignment_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 = ReservationServiceClient( + 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_assignment), + '__call__') as call: + client.create_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateAssignmentRequest() + + +@pytest.mark.asyncio +async def test_create_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + )) + response = await client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + + +@pytest.mark.asyncio +async def test_create_assignment_async_from_dict(): + await test_create_assignment_async(request_type=dict) + + +def test_create_assignment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.CreateAssignmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.create_assignment(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_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.CreateAssignmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + await client.create_assignment(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_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_assignment( + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].assignment == reservation.Assignment(name='name_value') + + +def test_create_assignment_flattened_error(): + client = ReservationServiceClient( + 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_assignment( + reservation.CreateAssignmentRequest(), + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + +@pytest.mark.asyncio +async def test_create_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_assignment( + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].assignment == reservation.Assignment(name='name_value') + + +@pytest.mark.asyncio +async def test_create_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_assignment( + reservation.CreateAssignmentRequest(), + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + +def test_list_assignments(transport: str = 'grpc', request_type=reservation.ListAssignmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_assignments_from_dict(): + test_list_assignments(request_type=dict) + + +def test_list_assignments_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 = ReservationServiceClient( + 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_assignments), + '__call__') as call: + client.list_assignments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListAssignmentsRequest() + + +@pytest.mark.asyncio +async def test_list_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_assignments_async_from_dict(): + await test_list_assignments_async(request_type=dict) + + +def test_list_assignments_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value = reservation.ListAssignmentsResponse() + client.list_assignments(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_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.ListAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) + await client.list_assignments(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_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_assignments( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_assignments_flattened_error(): + client = ReservationServiceClient( + 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_assignments( + reservation.ListAssignmentsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_assignments( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_assignments( + reservation.ListAssignmentsRequest(), + parent='parent_value', + ) + + +def test_list_assignments_pager(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_assignments(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + +def test_list_assignments_pages(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_assignments(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_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_assignments(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in responses) + +@pytest.mark.asyncio +async def test_list_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_assignments(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_delete_assignment(transport: str = 'grpc', request_type=reservation.DeleteAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteAssignmentRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_assignment_from_dict(): + test_delete_assignment(request_type=dict) + + +def test_delete_assignment_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 = ReservationServiceClient( + 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_assignment), + '__call__') as call: + client.delete_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteAssignmentRequest() + + +@pytest.mark.asyncio +async def test_delete_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteAssignmentRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_assignment_async_from_dict(): + await test_delete_assignment_async(request_type=dict) + + +def test_delete_assignment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteAssignmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value = None + client.delete_assignment(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_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.DeleteAssignmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_assignment(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_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__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_assignment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_assignment_flattened_error(): + client = ReservationServiceClient( + 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_assignment( + reservation.DeleteAssignmentRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__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_assignment( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_assignment( + reservation.DeleteAssignmentRequest(), + name='name_value', + ) + + +def test_search_assignments(transport: str = 'grpc', request_type=reservation.SearchAssignmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_assignments_from_dict(): + test_search_assignments(request_type=dict) + + +def test_search_assignments_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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + client.search_assignments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAssignmentsRequest() + + +@pytest.mark.asyncio +async def test_search_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_assignments_async_from_dict(): + await test_search_assignments_async(request_type=dict) + + +def test_search_assignments_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SearchAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value = reservation.SearchAssignmentsResponse() + client.search_assignments(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_search_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SearchAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) + await client.search_assignments(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_search_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_assignments( + parent='parent_value', + query='query_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].query == 'query_value' + + +def test_search_assignments_flattened_error(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search_assignments( + reservation.SearchAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +@pytest.mark.asyncio +async def test_search_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_assignments( + parent='parent_value', + query='query_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].query == 'query_value' + + +@pytest.mark.asyncio +async def test_search_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_assignments( + reservation.SearchAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_assignments_pager(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.search_assignments(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + +def test_search_assignments_pages(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.search_assignments(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_assignments(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in responses) + +@pytest.mark.asyncio +async def test_search_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_assignments(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_search_all_assignments(transport: str = 'grpc', request_type=reservation.SearchAllAssignmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAllAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAllAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_all_assignments_from_dict(): + test_search_all_assignments(request_type=dict) + + +def test_search_all_assignments_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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + client.search_all_assignments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAllAssignmentsRequest() + + +@pytest.mark.asyncio +async def test_search_all_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAllAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAllAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAllAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_all_assignments_async_from_dict(): + await test_search_all_assignments_async(request_type=dict) + + +def test_search_all_assignments_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SearchAllAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value = reservation.SearchAllAssignmentsResponse() + client.search_all_assignments(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_search_all_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.SearchAllAssignmentsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) + await client.search_all_assignments(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_search_all_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_all_assignments( + parent='parent_value', + query='query_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].query == 'query_value' + + +def test_search_all_assignments_flattened_error(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +@pytest.mark.asyncio +async def test_search_all_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_all_assignments( + parent='parent_value', + query='query_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].query == 'query_value' + + +@pytest.mark.asyncio +async def test_search_all_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_all_assignments_pager(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.search_all_assignments(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + +def test_search_all_assignments_pages(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.search_all_assignments(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_all_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_all_assignments(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in responses) + +@pytest.mark.asyncio +async def test_search_all_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_all_assignments(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_move_assignment(transport: str = 'grpc', request_type=reservation.MoveAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + ) + response = client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MoveAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + + +def test_move_assignment_from_dict(): + test_move_assignment(request_type=dict) + + +def test_move_assignment_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 = ReservationServiceClient( + 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.move_assignment), + '__call__') as call: + client.move_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MoveAssignmentRequest() + + +@pytest.mark.asyncio +async def test_move_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.MoveAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + )) + response = await client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MoveAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + + +@pytest.mark.asyncio +async def test_move_assignment_async_from_dict(): + await test_move_assignment_async(request_type=dict) + + +def test_move_assignment_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.MoveAssignmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.move_assignment(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_move_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.MoveAssignmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + await client.move_assignment(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_move_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.move_assignment( + name='name_value', + destination_id='destination_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].destination_id == 'destination_id_value' + + +def test_move_assignment_flattened_error(): + client = ReservationServiceClient( + 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.move_assignment( + reservation.MoveAssignmentRequest(), + name='name_value', + destination_id='destination_id_value', + ) + + +@pytest.mark.asyncio +async def test_move_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.move_assignment( + name='name_value', + destination_id='destination_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].destination_id == 'destination_id_value' + + +@pytest.mark.asyncio +async def test_move_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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.move_assignment( + reservation.MoveAssignmentRequest(), + name='name_value', + destination_id='destination_id_value', + ) + + +def test_get_bi_reservation(transport: str = 'grpc', request_type=reservation.GetBiReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation( + name='name_value', + size=443, + ) + response = client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetBiReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +def test_get_bi_reservation_from_dict(): + test_get_bi_reservation(request_type=dict) + + +def test_get_bi_reservation_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 = ReservationServiceClient( + 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_bi_reservation), + '__call__') as call: + client.get_bi_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetBiReservationRequest() + + +@pytest.mark.asyncio +async def test_get_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetBiReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + response = await client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetBiReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.asyncio +async def test_get_bi_reservation_async_from_dict(): + await test_get_bi_reservation_async(request_type=dict) + + +def test_get_bi_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetBiReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.get_bi_reservation(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_bi_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.GetBiReservationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + await client.get_bi_reservation(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_bi_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_bi_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_bi_reservation_flattened_error(): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.GetBiReservationRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_bi_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_bi_reservation( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_bi_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_bi_reservation( + reservation.GetBiReservationRequest(), + name='name_value', + ) + + +def test_update_bi_reservation(transport: str = 'grpc', request_type=reservation.UpdateBiReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation( + name='name_value', + size=443, + ) + response = client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateBiReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +def test_update_bi_reservation_from_dict(): + test_update_bi_reservation(request_type=dict) + + +def test_update_bi_reservation_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 = ReservationServiceClient( + 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_bi_reservation), + '__call__') as call: + client.update_bi_reservation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateBiReservationRequest() + + +@pytest.mark.asyncio +async def test_update_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateBiReservationRequest): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + response = await client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateBiReservationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.asyncio +async def test_update_bi_reservation_async_from_dict(): + await test_update_bi_reservation_async(request_type=dict) + + +def test_update_bi_reservation_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.UpdateBiReservationRequest() + + request.bi_reservation.name = 'bi_reservation.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.update_bi_reservation(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', + 'bi_reservation.name=bi_reservation.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_bi_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reservation.UpdateBiReservationRequest() + + request.bi_reservation.name = 'bi_reservation.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + await client.update_bi_reservation(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', + 'bi_reservation.name=bi_reservation.name/value', + ) in kw['metadata'] + + +def test_update_bi_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_bi_reservation( + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].bi_reservation == reservation.BiReservation(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_bi_reservation_flattened_error(): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_bi_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_bi_reservation( + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].bi_reservation == reservation.BiReservation(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_bi_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + 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_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ReservationServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ReservationServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ReservationServiceGrpcTransport, + ) + +def test_reservation_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ReservationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_reservation_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.ReservationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_reservation', + 'list_reservations', + 'get_reservation', + 'delete_reservation', + 'update_reservation', + 'create_capacity_commitment', + 'list_capacity_commitments', + 'get_capacity_commitment', + 'delete_capacity_commitment', + 'update_capacity_commitment', + 'split_capacity_commitment', + 'merge_capacity_commitments', + 'create_assignment', + 'list_assignments', + 'delete_assignment', + 'search_assignments', + 'search_all_assignments', + 'move_assignment', + 'get_bi_reservation', + 'update_bi_reservation', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + +@requires_google_auth_gte_1_25_0 +def test_reservation_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReservationServiceTransport( + 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/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_reservation_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReservationServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_reservation_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReservationServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_reservation_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + ReservationServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_reservation_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + ReservationServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_reservation_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_reservation_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.ReservationServiceGrpcTransport, grpc_helpers), + (transports.ReservationServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_reservation_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "bigqueryreservation.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="bigqueryreservation.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_reservation_service_host_no_port(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com'), + ) + assert client.transport._host == 'bigqueryreservation.googleapis.com:443' + + +def test_reservation_service_host_with_port(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com:8000'), + ) + assert client.transport._host == 'bigqueryreservation.googleapis.com:8000' + +def test_reservation_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReservationServiceGrpcTransport( + 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_reservation_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReservationServiceGrpcAsyncIOTransport( + 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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_assignment_path(): + project = "squid" + location = "clam" + reservation = "whelk" + assignment = "octopus" + expected = "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) + actual = ReservationServiceClient.assignment_path(project, location, reservation, assignment) + assert expected == actual + + +def test_parse_assignment_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "reservation": "cuttlefish", + "assignment": "mussel", + } + path = ReservationServiceClient.assignment_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_assignment_path(path) + assert expected == actual + +def test_bi_reservation_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) + actual = ReservationServiceClient.bi_reservation_path(project, location) + assert expected == actual + + +def test_parse_bi_reservation_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = ReservationServiceClient.bi_reservation_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_bi_reservation_path(path) + assert expected == actual + +def test_capacity_commitment_path(): + project = "squid" + location = "clam" + capacity_commitment = "whelk" + expected = "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) + actual = ReservationServiceClient.capacity_commitment_path(project, location, capacity_commitment) + assert expected == actual + + +def test_parse_capacity_commitment_path(): + expected = { + "project": "octopus", + "location": "oyster", + "capacity_commitment": "nudibranch", + } + path = ReservationServiceClient.capacity_commitment_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_capacity_commitment_path(path) + assert expected == actual + +def test_reservation_path(): + project = "cuttlefish" + location = "mussel" + reservation = "winkle" + expected = "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) + actual = ReservationServiceClient.reservation_path(project, location, reservation) + assert expected == actual + + +def test_parse_reservation_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "reservation": "abalone", + } + path = ReservationServiceClient.reservation_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_reservation_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = ReservationServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = ReservationServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = ReservationServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = ReservationServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = ReservationServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = ReservationServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = ReservationServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = ReservationServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.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 = ReservationServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = ReservationServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = ReservationServiceClient.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 = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'grpc', + ] + for transport in transports: + client = ReservationServiceClient( + 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() From 283fcdf349c70d5af74edb536b643a07e329a64b Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 7 Oct 2021 19:38:45 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../reservation_service/async_client.py | 6 + .../services/reservation_service/client.py | 18 +- .../reservation_service/transports/base.py | 9 + .../reservation_service/transports/grpc.py | 3 + .../transports/grpc_asyncio.py | 3 + .../types/reservation.py | 3 + owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - .../reservation_service.rst | 10 - .../docs/bigquery_reservation_v1/services.rst | 6 - .../v1/docs/bigquery_reservation_v1/types.rst | 7 - owl-bot-staging/v1/docs/conf.py | 376 - owl-bot-staging/v1/docs/index.rst | 7 - .../cloud/bigquery_reservation/__init__.py | 83 - .../cloud/bigquery_reservation/py.typed | 2 - .../cloud/bigquery_reservation_v1/__init__.py | 84 - .../gapic_metadata.json | 223 - .../cloud/bigquery_reservation_v1/py.typed | 2 - .../services/__init__.py | 15 - .../services/reservation_service/__init__.py | 22 - .../reservation_service/async_client.py | 2163 ------ .../services/reservation_service/client.py | 2317 ------ .../services/reservation_service/pagers.py | 628 -- .../transports/__init__.py | 33 - .../reservation_service/transports/base.py | 516 -- .../reservation_service/transports/grpc.py | 926 --- .../transports/grpc_asyncio.py | 931 --- .../bigquery_reservation_v1/types/__init__.py | 80 - .../types/reservation.py | 1023 --- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../fixup_bigquery_reservation_v1_keywords.py | 195 - owl-bot-staging/v1/setup.py | 54 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../gapic/bigquery_reservation_v1/__init__.py | 16 - .../test_reservation_service.py | 6795 ----------------- .../test_reservation_service.py | 50 + 40 files changed, 88 insertions(+), 16769 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst delete mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py diff --git a/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py index fc2c5f10..05ae6d34 100644 --- a/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py +++ b/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py @@ -2119,6 +2119,12 @@ async def update_bi_reservation( # Done; return the response. return response + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py index b8079a65..0387956b 100644 --- a/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py +++ b/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py @@ -423,10 +423,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def create_reservation( @@ -2262,6 +2259,19 @@ def update_bi_reservation( # Done; return the response. return response + def __enter__(self): + 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() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py index ff994fc1..ed076e2c 100644 --- a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py +++ b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py @@ -353,6 +353,15 @@ def _prep_wrapped_messages(self, 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_reservation( self, diff --git a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py index 5164a2d9..b13017a8 100644 --- a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py +++ b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py @@ -950,5 +950,8 @@ def update_bi_reservation( ) return self._stubs["update_bi_reservation"] + def close(self): + self.grpc_channel.close() + __all__ = ("ReservationServiceGrpcTransport",) diff --git a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py index 56fbb16f..b9b8ac36 100644 --- a/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py +++ b/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py @@ -974,5 +974,8 @@ def update_bi_reservation( ) return self._stubs["update_bi_reservation"] + def close(self): + return self.grpc_channel.close() + __all__ = ("ReservationServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/bigquery_reservation_v1/types/reservation.py b/google/cloud/bigquery_reservation_v1/types/reservation.py index e409852a..8fa7bf94 100644 --- a/google/cloud/bigquery_reservation_v1/types/reservation.py +++ b/google/cloud/bigquery_reservation_v1/types/reservation.py @@ -732,6 +732,7 @@ class MoveAssignmentRequest(proto.Message): class BiReservation(proto.Message): r"""Represents a BI Reservation. + Attributes: name (str): The resource name of the singleton BI reservation. @@ -751,6 +752,7 @@ class BiReservation(proto.Message): class GetBiReservationRequest(proto.Message): r"""A request to get a singleton BI reservation. + Attributes: name (str): Required. Name of the requested reservation, for example: @@ -762,6 +764,7 @@ class GetBiReservationRequest(proto.Message): class UpdateBiReservationRequest(proto.Message): r"""A request to update a BI reservation. + Attributes: bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): A reservation to update. diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index 81dbade7..00000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/bigquery_reservation/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index c1c2e1b5..00000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/bigquery_reservation *.py -recursive-include google/cloud/bigquery_reservation_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 15b8ffa5..00000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Bigquery Reservation 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 Bigquery Reservation 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/bigquery_reservation_v1/reservation_service.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst deleted file mode 100644 index 35e6b3cf..00000000 --- a/owl-bot-staging/v1/docs/bigquery_reservation_v1/reservation_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -ReservationService ------------------------------------- - -.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service - :members: - :inherited-members: - -.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst deleted file mode 100644 index 3f9e9577..00000000 --- a/owl-bot-staging/v1/docs/bigquery_reservation_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Bigquery Reservation v1 API -===================================================== -.. toctree:: - :maxdepth: 2 - - reservation_service diff --git a/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst b/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst deleted file mode 100644 index eca7ccfb..00000000 --- a/owl-bot-staging/v1/docs/bigquery_reservation_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Bigquery Reservation v1 API -================================================== - -.. automodule:: google.cloud.bigquery_reservation_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 60f8beb4..00000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-bigquery-reservation documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "1.6.3" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-bigquery-reservation" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-bigquery-reservation-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "google-cloud-bigquery-reservation.tex", - u"google-cloud-bigquery-reservation Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - master_doc, - "google-cloud-bigquery-reservation", - u"Google Cloud Bigquery Reservation Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "google-cloud-bigquery-reservation", - u"google-cloud-bigquery-reservation Documentation", - author, - "google-cloud-bigquery-reservation", - "GAPIC library for Google Cloud Bigquery Reservation API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index 0f4f9035..00000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - bigquery_reservation_v1/services - bigquery_reservation_v1/types diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py deleted file mode 100644 index 9bc2ae0c..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation/__init__.py +++ /dev/null @@ -1,83 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.cloud.bigquery_reservation_v1.services.reservation_service.client import ReservationServiceClient -from google.cloud.bigquery_reservation_v1.services.reservation_service.async_client import ReservationServiceAsyncClient - -from google.cloud.bigquery_reservation_v1.types.reservation import Assignment -from google.cloud.bigquery_reservation_v1.types.reservation import BiReservation -from google.cloud.bigquery_reservation_v1.types.reservation import CapacityCommitment -from google.cloud.bigquery_reservation_v1.types.reservation import CreateAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import CreateCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetBiReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import MergeCapacityCommitmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import MoveAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import Reservation -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentResponse -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateBiReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateReservationRequest - -__all__ = ('ReservationServiceClient', - 'ReservationServiceAsyncClient', - 'Assignment', - 'BiReservation', - 'CapacityCommitment', - 'CreateAssignmentRequest', - 'CreateCapacityCommitmentRequest', - 'CreateReservationRequest', - 'DeleteAssignmentRequest', - 'DeleteCapacityCommitmentRequest', - 'DeleteReservationRequest', - 'GetBiReservationRequest', - 'GetCapacityCommitmentRequest', - 'GetReservationRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'MergeCapacityCommitmentsRequest', - 'MoveAssignmentRequest', - 'Reservation', - 'SearchAllAssignmentsRequest', - 'SearchAllAssignmentsResponse', - 'SearchAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'UpdateBiReservationRequest', - 'UpdateCapacityCommitmentRequest', - 'UpdateReservationRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed b/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed deleted file mode 100644 index ff261ee1..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py deleted file mode 100644 index db27ff62..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/__init__.py +++ /dev/null @@ -1,84 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .services.reservation_service import ReservationServiceClient -from .services.reservation_service import ReservationServiceAsyncClient - -from .types.reservation import Assignment -from .types.reservation import BiReservation -from .types.reservation import CapacityCommitment -from .types.reservation import CreateAssignmentRequest -from .types.reservation import CreateCapacityCommitmentRequest -from .types.reservation import CreateReservationRequest -from .types.reservation import DeleteAssignmentRequest -from .types.reservation import DeleteCapacityCommitmentRequest -from .types.reservation import DeleteReservationRequest -from .types.reservation import GetBiReservationRequest -from .types.reservation import GetCapacityCommitmentRequest -from .types.reservation import GetReservationRequest -from .types.reservation import ListAssignmentsRequest -from .types.reservation import ListAssignmentsResponse -from .types.reservation import ListCapacityCommitmentsRequest -from .types.reservation import ListCapacityCommitmentsResponse -from .types.reservation import ListReservationsRequest -from .types.reservation import ListReservationsResponse -from .types.reservation import MergeCapacityCommitmentsRequest -from .types.reservation import MoveAssignmentRequest -from .types.reservation import Reservation -from .types.reservation import SearchAllAssignmentsRequest -from .types.reservation import SearchAllAssignmentsResponse -from .types.reservation import SearchAssignmentsRequest -from .types.reservation import SearchAssignmentsResponse -from .types.reservation import SplitCapacityCommitmentRequest -from .types.reservation import SplitCapacityCommitmentResponse -from .types.reservation import UpdateBiReservationRequest -from .types.reservation import UpdateCapacityCommitmentRequest -from .types.reservation import UpdateReservationRequest - -__all__ = ( - 'ReservationServiceAsyncClient', -'Assignment', -'BiReservation', -'CapacityCommitment', -'CreateAssignmentRequest', -'CreateCapacityCommitmentRequest', -'CreateReservationRequest', -'DeleteAssignmentRequest', -'DeleteCapacityCommitmentRequest', -'DeleteReservationRequest', -'GetBiReservationRequest', -'GetCapacityCommitmentRequest', -'GetReservationRequest', -'ListAssignmentsRequest', -'ListAssignmentsResponse', -'ListCapacityCommitmentsRequest', -'ListCapacityCommitmentsResponse', -'ListReservationsRequest', -'ListReservationsResponse', -'MergeCapacityCommitmentsRequest', -'MoveAssignmentRequest', -'Reservation', -'ReservationServiceClient', -'SearchAllAssignmentsRequest', -'SearchAllAssignmentsResponse', -'SearchAssignmentsRequest', -'SearchAssignmentsResponse', -'SplitCapacityCommitmentRequest', -'SplitCapacityCommitmentResponse', -'UpdateBiReservationRequest', -'UpdateCapacityCommitmentRequest', -'UpdateReservationRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json deleted file mode 100644 index d8fad3d5..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json +++ /dev/null @@ -1,223 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.bigquery_reservation_v1", - "protoPackage": "google.cloud.bigquery.reservation.v1", - "schema": "1.0", - "services": { - "ReservationService": { - "clients": { - "grpc": { - "libraryClient": "ReservationServiceClient", - "rpcs": { - "CreateAssignment": { - "methods": [ - "create_assignment" - ] - }, - "CreateCapacityCommitment": { - "methods": [ - "create_capacity_commitment" - ] - }, - "CreateReservation": { - "methods": [ - "create_reservation" - ] - }, - "DeleteAssignment": { - "methods": [ - "delete_assignment" - ] - }, - "DeleteCapacityCommitment": { - "methods": [ - "delete_capacity_commitment" - ] - }, - "DeleteReservation": { - "methods": [ - "delete_reservation" - ] - }, - "GetBiReservation": { - "methods": [ - "get_bi_reservation" - ] - }, - "GetCapacityCommitment": { - "methods": [ - "get_capacity_commitment" - ] - }, - "GetReservation": { - "methods": [ - "get_reservation" - ] - }, - "ListAssignments": { - "methods": [ - "list_assignments" - ] - }, - "ListCapacityCommitments": { - "methods": [ - "list_capacity_commitments" - ] - }, - "ListReservations": { - "methods": [ - "list_reservations" - ] - }, - "MergeCapacityCommitments": { - "methods": [ - "merge_capacity_commitments" - ] - }, - "MoveAssignment": { - "methods": [ - "move_assignment" - ] - }, - "SearchAllAssignments": { - "methods": [ - "search_all_assignments" - ] - }, - "SearchAssignments": { - "methods": [ - "search_assignments" - ] - }, - "SplitCapacityCommitment": { - "methods": [ - "split_capacity_commitment" - ] - }, - "UpdateBiReservation": { - "methods": [ - "update_bi_reservation" - ] - }, - "UpdateCapacityCommitment": { - "methods": [ - "update_capacity_commitment" - ] - }, - "UpdateReservation": { - "methods": [ - "update_reservation" - ] - } - } - }, - "grpc-async": { - "libraryClient": "ReservationServiceAsyncClient", - "rpcs": { - "CreateAssignment": { - "methods": [ - "create_assignment" - ] - }, - "CreateCapacityCommitment": { - "methods": [ - "create_capacity_commitment" - ] - }, - "CreateReservation": { - "methods": [ - "create_reservation" - ] - }, - "DeleteAssignment": { - "methods": [ - "delete_assignment" - ] - }, - "DeleteCapacityCommitment": { - "methods": [ - "delete_capacity_commitment" - ] - }, - "DeleteReservation": { - "methods": [ - "delete_reservation" - ] - }, - "GetBiReservation": { - "methods": [ - "get_bi_reservation" - ] - }, - "GetCapacityCommitment": { - "methods": [ - "get_capacity_commitment" - ] - }, - "GetReservation": { - "methods": [ - "get_reservation" - ] - }, - "ListAssignments": { - "methods": [ - "list_assignments" - ] - }, - "ListCapacityCommitments": { - "methods": [ - "list_capacity_commitments" - ] - }, - "ListReservations": { - "methods": [ - "list_reservations" - ] - }, - "MergeCapacityCommitments": { - "methods": [ - "merge_capacity_commitments" - ] - }, - "MoveAssignment": { - "methods": [ - "move_assignment" - ] - }, - "SearchAllAssignments": { - "methods": [ - "search_all_assignments" - ] - }, - "SearchAssignments": { - "methods": [ - "search_assignments" - ] - }, - "SplitCapacityCommitment": { - "methods": [ - "split_capacity_commitment" - ] - }, - "UpdateBiReservation": { - "methods": [ - "update_bi_reservation" - ] - }, - "UpdateCapacityCommitment": { - "methods": [ - "update_capacity_commitment" - ] - }, - "UpdateReservation": { - "methods": [ - "update_reservation" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed deleted file mode 100644 index ff261ee1..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py deleted file mode 100644 index 4de65971..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py deleted file mode 100644 index a9b2e046..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import ReservationServiceClient -from .async_client import ReservationServiceAsyncClient - -__all__ = ( - 'ReservationServiceClient', - 'ReservationServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py deleted file mode 100644 index 7258c24b..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py +++ /dev/null @@ -1,2163 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources -import warnings - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -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 -from .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport -from .client import ReservationServiceClient - - -class ReservationServiceAsyncClient: - """This API allows users to manage their flat-rate BigQuery - reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - """ - - _client: ReservationServiceClient - - DEFAULT_ENDPOINT = ReservationServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - - assignment_path = staticmethod(ReservationServiceClient.assignment_path) - parse_assignment_path = staticmethod(ReservationServiceClient.parse_assignment_path) - bi_reservation_path = staticmethod(ReservationServiceClient.bi_reservation_path) - parse_bi_reservation_path = staticmethod(ReservationServiceClient.parse_bi_reservation_path) - capacity_commitment_path = staticmethod(ReservationServiceClient.capacity_commitment_path) - parse_capacity_commitment_path = staticmethod(ReservationServiceClient.parse_capacity_commitment_path) - reservation_path = staticmethod(ReservationServiceClient.reservation_path) - parse_reservation_path = staticmethod(ReservationServiceClient.parse_reservation_path) - common_billing_account_path = staticmethod(ReservationServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(ReservationServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(ReservationServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(ReservationServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(ReservationServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(ReservationServiceClient.parse_common_organization_path) - common_project_path = staticmethod(ReservationServiceClient.common_project_path) - parse_common_project_path = staticmethod(ReservationServiceClient.parse_common_project_path) - common_location_path = staticmethod(ReservationServiceClient.common_location_path) - parse_common_location_path = staticmethod(ReservationServiceClient.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: - ReservationServiceAsyncClient: The constructed client. - """ - return ReservationServiceClient.from_service_account_info.__func__(ReservationServiceAsyncClient, 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: - ReservationServiceAsyncClient: The constructed client. - """ - return ReservationServiceClient.from_service_account_file.__func__(ReservationServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> ReservationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ReservationServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(ReservationServiceClient).get_transport_class, type(ReservationServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, ReservationServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the reservation service client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.ReservationServiceTransport]): 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 = ReservationServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_reservation(self, - request: gcbr_reservation.CreateReservationRequest = None, - *, - parent: str = None, - reservation: gcbr_reservation.Reservation = None, - reservation_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcbr_reservation.Reservation: - r"""Creates a new reservation resource. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.CreateReservationRequest`): - The request object. The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - parent (:class:`str`): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): - Definition of the new reservation to - create. - - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation_id (:class:`str`): - The reservation ID. This field must - only contain lower case alphanumeric - characters or dash. Max length is 64 - characters. - - This corresponds to the ``reservation_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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, reservation, reservation_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 = gcbr_reservation.CreateReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if reservation is not None: - request.reservation = reservation - if reservation_id is not None: - request.reservation_id = reservation_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_reservation, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_reservations(self, - request: reservation.ListReservationsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListReservationsAsyncPager: - r"""Lists all the reservations for the project in the - specified location. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.ListReservationsRequest`): - The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - parent (:class:`str`): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager: - The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.ListReservationsRequest(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_reservations, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListReservationsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_reservation(self, - request: reservation.GetReservationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Reservation: - r"""Returns information about the reservation. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.GetReservationRequest`): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - name (:class:`str`): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.GetReservationRequest(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_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_reservation(self, - request: reservation.DeleteReservationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest`): - The request object. The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - name (:class:`str`): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.DeleteReservationRequest(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_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def update_reservation(self, - request: gcbr_reservation.UpdateReservationRequest = None, - *, - reservation: gcbr_reservation.Reservation = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcbr_reservation.Reservation: - r"""Updates an existing reservation resource. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest`): - The request object. The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): - Content of the reservation to update. - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Standard field mask for the set 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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([reservation, 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 = gcbr_reservation.UpdateReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if reservation is not None: - request.reservation = reservation - 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_reservation, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("reservation.name", request.reservation.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_capacity_commitment(self, - request: reservation.CreateCapacityCommitmentRequest = None, - *, - parent: str = None, - capacity_commitment: reservation.CapacityCommitment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Creates a new capacity commitment resource. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest`): - The request object. The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - parent (:class:`str`): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): - Content of the capacity commitment to - create. - - This corresponds to the ``capacity_commitment`` 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, capacity_commitment]) - 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 = reservation.CreateCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - - # 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_capacity_commitment, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_capacity_commitments(self, - request: reservation.ListCapacityCommitmentsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListCapacityCommitmentsAsyncPager: - r"""Lists all the capacity commitments for the admin - project. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest`): - The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - parent (:class:`str`): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListCapacityCommitmentsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_capacity_commitment(self, - request: reservation.GetCapacityCommitmentRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Returns information about the capacity commitment. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest`): - The request object. The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - name (:class:`str`): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_capacity_commitment(self, - request: reservation.DeleteCapacityCommitmentRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest`): - The request object. The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - name (:class:`str`): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def update_capacity_commitment(self, - request: reservation.UpdateCapacityCommitmentRequest = None, - *, - capacity_commitment: reservation.CapacityCommitment = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest`): - The request object. The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): - Content of the capacity commitment to - update. - - This corresponds to the ``capacity_commitment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Standard field mask for the set 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([capacity_commitment, 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 = reservation.UpdateCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - 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_capacity_commitment, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("capacity_commitment.name", request.capacity_commitment.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def split_capacity_commitment(self, - request: reservation.SplitCapacityCommitmentRequest = None, - *, - name: str = None, - slot_count: int = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you would change the plan of the first one to - ``FLEX`` and then delete it. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest`): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - name (:class:`str`): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - slot_count (:class:`int`): - Number of slots in the capacity - commitment after the split. - - This corresponds to the ``slot_count`` 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.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, slot_count]) - 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 = reservation.SplitCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if slot_count is not None: - request.slot_count = slot_count - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.split_capacity_commitment, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def merge_capacity_commitments(self, - request: reservation.MergeCapacityCommitmentsRequest = None, - *, - parent: str = None, - capacity_commitment_ids: Sequence[str] = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest`): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - parent (:class:`str`): - Parent resource that identifies admin project and - location e.g., ``projects/myproject/locations/us`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment_ids (:class:`Sequence[str]`): - Ids of capacity commitments to merge. - These capacity commitments must exist - under admin project and location - specified in the parent. - ID is the last portion of capacity - commitment name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - - This corresponds to the ``capacity_commitment_ids`` 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, capacity_commitment_ids]) - 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 = reservation.MergeCapacityCommitmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment_ids: - request.capacity_commitment_ids.extend(capacity_commitment_ids) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.merge_capacity_commitments, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_assignment(self, - request: reservation.CreateAssignmentRequest = None, - *, - parent: str = None, - assignment: reservation.Assignment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Assignment: - r"""Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest`): - The request object. The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" - permission is required on the related assignee. - parent (:class:`str`): - Required. The parent resource name of the assignment - E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): - Assignment resource to create. - This corresponds to the ``assignment`` 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.bigquery_reservation_v1.types.Assignment: - A Assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, assignment]) - 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 = reservation.CreateAssignmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assignment is not None: - request.assignment = assignment - - # 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_assignment, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_assignments(self, - request: reservation.ListAssignmentsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListAssignmentsAsyncPager: - r"""Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest`): - The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - parent (:class:`str`): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.ListAssignmentsRequest(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_assignments, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_assignment(self, - request: reservation.DeleteAssignmentRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest`): - The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. - name (:class:`str`): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.DeleteAssignmentRequest(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_assignment, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def search_assignments(self, - request: reservation.SearchAssignmentsRequest = None, - *, - parent: str = None, - query: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchAssignmentsAsyncPager: - r"""Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest`): - The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (:class:`str`): - Required. The resource name of the admin - project(containing project and location), e.g.: - ``projects/myproject/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager: - The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - warnings.warn("ReservationServiceAsyncClient.search_assignments is deprecated", - DeprecationWarning) - - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, query]) - 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 = reservation.SearchAssignmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.search_assignments, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.SearchAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def search_all_assignments(self, - request: reservation.SearchAllAssignmentsRequest = None, - *, - parent: str = None, - query: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchAllAssignmentsAsyncPager: - r"""Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest`): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (:class:`str`): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, query]) - 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 = reservation.SearchAllAssignmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.search_all_assignments, - 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.SearchAllAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def move_assignment(self, - request: reservation.MoveAssignmentRequest = None, - *, - name: str = None, - destination_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Assignment: - r"""Moves an assignment under a new reservation. - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest`): - The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. - name (:class:`str`): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - destination_id (:class:`str`): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - - This corresponds to the ``destination_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.bigquery_reservation_v1.types.Assignment: - A Assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, destination_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 = reservation.MoveAssignmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if destination_id is not None: - request.destination_id = destination_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.move_assignment, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_bi_reservation(self, - request: reservation.GetBiReservationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.BiReservation: - r"""Retrieves a BI reservation. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest`): - The request object. A request to get a singleton BI - reservation. - name (:class:`str`): - Required. Name of the requested reservation, for - example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - - 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.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = reservation.GetBiReservationRequest(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_bi_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_bi_reservation(self, - request: reservation.UpdateBiReservationRequest = None, - *, - bi_reservation: reservation.BiReservation = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.BiReservation: - r"""Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Args: - request (:class:`google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest`): - The request object. A request to update a BI - reservation. - bi_reservation (:class:`google.cloud.bigquery_reservation_v1.types.BiReservation`): - A reservation to update. - This corresponds to the ``bi_reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - A list of fields to be updated in - this request. - - 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.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([bi_reservation, 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 = reservation.UpdateBiReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if bi_reservation is not None: - request.bi_reservation = bi_reservation - 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_bi_reservation, - default_timeout=300.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("bi_reservation.name", request.bi_reservation.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-bigquery-reservation", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "ReservationServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py deleted file mode 100644 index d5eeb37d..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py +++ /dev/null @@ -1,2317 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources -import warnings - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -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 -from .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import ReservationServiceGrpcTransport -from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport - - -class ReservationServiceClientMeta(type): - """Metaclass for the ReservationService 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[ReservationServiceTransport]] - _transport_registry["grpc"] = ReservationServiceGrpcTransport - _transport_registry["grpc_asyncio"] = ReservationServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[ReservationServiceTransport]: - """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 ReservationServiceClient(metaclass=ReservationServiceClientMeta): - """This API allows users to manage their flat-rate BigQuery - reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - """ - - @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 = "bigqueryreservation.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: - ReservationServiceClient: 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: - ReservationServiceClient: 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) -> ReservationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ReservationServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def assignment_path(project: str,location: str,reservation: str,assignment: str,) -> str: - """Returns a fully-qualified assignment string.""" - return "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) - - @staticmethod - def parse_assignment_path(path: str) -> Dict[str,str]: - """Parses a assignment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)/assignments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def bi_reservation_path(project: str,location: str,) -> str: - """Returns a fully-qualified bi_reservation string.""" - return "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) - - @staticmethod - def parse_bi_reservation_path(path: str) -> Dict[str,str]: - """Parses a bi_reservation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/biReservation$", path) - return m.groupdict() if m else {} - - @staticmethod - def capacity_commitment_path(project: str,location: str,capacity_commitment: str,) -> str: - """Returns a fully-qualified capacity_commitment string.""" - return "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) - - @staticmethod - def parse_capacity_commitment_path(path: str) -> Dict[str,str]: - """Parses a capacity_commitment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/capacityCommitments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def reservation_path(project: str,location: str,reservation: str,) -> str: - """Returns a fully-qualified reservation string.""" - return "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) - - @staticmethod - def parse_reservation_path(path: str) -> Dict[str,str]: - """Parses a reservation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, ReservationServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the reservation service client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ReservationServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, ReservationServiceTransport): - # transport is a ReservationServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - ) - - def create_reservation(self, - request: Union[gcbr_reservation.CreateReservationRequest, dict] = None, - *, - parent: str = None, - reservation: gcbr_reservation.Reservation = None, - reservation_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcbr_reservation.Reservation: - r"""Creates a new reservation resource. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]): - The request object. The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - parent (str): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Definition of the new reservation to - create. - - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation_id (str): - The reservation ID. This field must - only contain lower case alphanumeric - characters or dash. Max length is 64 - characters. - - This corresponds to the ``reservation_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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, reservation, reservation_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 gcbr_reservation.CreateReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, gcbr_reservation.CreateReservationRequest): - request = gcbr_reservation.CreateReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if reservation is not None: - request.reservation = reservation - if reservation_id is not None: - request.reservation_id = reservation_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_reservations(self, - request: Union[reservation.ListReservationsRequest, dict] = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListReservationsPager: - r"""Lists all the reservations for the project in the - specified location. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]): - The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - parent (str): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager: - The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.ListReservationsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.ListReservationsRequest): - request = reservation.ListReservationsRequest(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_reservations] - - # 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.ListReservationsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_reservation(self, - request: Union[reservation.GetReservationRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Reservation: - r"""Returns information about the reservation. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.GetReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.GetReservationRequest): - request = reservation.GetReservationRequest(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_reservation] - - # 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_reservation(self, - request: Union[reservation.DeleteReservationRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]): - The request object. The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.DeleteReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.DeleteReservationRequest): - request = reservation.DeleteReservationRequest(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_reservation] - - # 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 update_reservation(self, - request: Union[gcbr_reservation.UpdateReservationRequest, dict] = None, - *, - reservation: gcbr_reservation.Reservation = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> gcbr_reservation.Reservation: - r"""Updates an existing reservation resource. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]): - The request object. The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Content of the reservation to update. - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set 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.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([reservation, 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 gcbr_reservation.UpdateReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, gcbr_reservation.UpdateReservationRequest): - request = gcbr_reservation.UpdateReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if reservation is not None: - request.reservation = reservation - 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_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("reservation.name", request.reservation.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_capacity_commitment(self, - request: Union[reservation.CreateCapacityCommitmentRequest, dict] = None, - *, - parent: str = None, - capacity_commitment: reservation.CapacityCommitment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Creates a new capacity commitment resource. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to - create. - - This corresponds to the ``capacity_commitment`` 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, capacity_commitment]) - 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 reservation.CreateCapacityCommitmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.CreateCapacityCommitmentRequest): - request = reservation.CreateCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_capacity_commitment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_capacity_commitments(self, - request: Union[reservation.ListCapacityCommitmentsRequest, dict] = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListCapacityCommitmentsPager: - r"""Lists all the capacity commitments for the admin - project. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]): - The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.ListCapacityCommitmentsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.ListCapacityCommitmentsRequest): - request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments] - - # 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.ListCapacityCommitmentsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_capacity_commitment(self, - request: Union[reservation.GetCapacityCommitmentRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Returns information about the capacity commitment. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - name (str): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.GetCapacityCommitmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.GetCapacityCommitmentRequest): - request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment] - - # 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_capacity_commitment(self, - request: Union[reservation.DeleteCapacityCommitmentRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - name (str): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.DeleteCapacityCommitmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): - request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment] - - # 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 update_capacity_commitment(self, - request: Union[reservation.UpdateCapacityCommitmentRequest, dict] = None, - *, - capacity_commitment: reservation.CapacityCommitment = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to - update. - - This corresponds to the ``capacity_commitment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([capacity_commitment, 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 reservation.UpdateCapacityCommitmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): - request = reservation.UpdateCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - 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_capacity_commitment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("capacity_commitment.name", request.capacity_commitment.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def split_capacity_commitment(self, - request: Union[reservation.SplitCapacityCommitmentRequest, dict] = None, - *, - name: str = None, - slot_count: int = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you would change the plan of the first one to - ``FLEX`` and then delete it. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - name (str): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - slot_count (int): - Number of slots in the capacity - commitment after the split. - - This corresponds to the ``slot_count`` 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.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, slot_count]) - 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 reservation.SplitCapacityCommitmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.SplitCapacityCommitmentRequest): - request = reservation.SplitCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if slot_count is not None: - request.slot_count = slot_count - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.split_capacity_commitment] - - # 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 merge_capacity_commitments(self, - request: Union[reservation.MergeCapacityCommitmentsRequest, dict] = None, - *, - parent: str = None, - capacity_commitment_ids: Sequence[str] = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.CapacityCommitment: - r"""Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - parent (str): - Parent resource that identifies admin project and - location e.g., ``projects/myproject/locations/us`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment_ids (Sequence[str]): - Ids of capacity commitments to merge. - These capacity commitments must exist - under admin project and location - specified in the parent. - ID is the last portion of capacity - commitment name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - - This corresponds to the ``capacity_commitment_ids`` 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.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, capacity_commitment_ids]) - 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 reservation.MergeCapacityCommitmentsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): - request = reservation.MergeCapacityCommitmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment_ids is not None: - request.capacity_commitment_ids = capacity_commitment_ids - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.merge_capacity_commitments] - - # 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 create_assignment(self, - request: Union[reservation.CreateAssignmentRequest, dict] = None, - *, - parent: str = None, - assignment: reservation.Assignment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Assignment: - r"""Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]): - The request object. The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" - permission is required on the related assignee. - parent (str): - Required. The parent resource name of the assignment - E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Assignment resource to create. - This corresponds to the ``assignment`` 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.bigquery_reservation_v1.types.Assignment: - A Assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, assignment]) - 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 reservation.CreateAssignmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.CreateAssignmentRequest): - request = reservation.CreateAssignmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assignment is not None: - request.assignment = assignment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_assignment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_assignments(self, - request: Union[reservation.ListAssignmentsRequest, dict] = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListAssignmentsPager: - r"""Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - parent (str): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - - 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.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.ListAssignmentsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.ListAssignmentsRequest): - request = reservation.ListAssignmentsRequest(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_assignments] - - # 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.ListAssignmentsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_assignment(self, - request: Union[reservation.DeleteAssignmentRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]): - The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. - name (str): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - 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. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.DeleteAssignmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.DeleteAssignmentRequest): - request = reservation.DeleteAssignmentRequest(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_assignment] - - # 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 search_assignments(self, - request: Union[reservation.SearchAssignmentsRequest, dict] = None, - *, - parent: str = None, - query: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchAssignmentsPager: - r"""Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (str): - Required. The resource name of the admin - project(containing project and location), e.g.: - ``projects/myproject/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager: - The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - warnings.warn("ReservationServiceClient.search_assignments is deprecated", - DeprecationWarning) - - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, query]) - 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 reservation.SearchAssignmentsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.SearchAssignmentsRequest): - request = reservation.SearchAssignmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.search_assignments] - - # 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.SearchAssignmentsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def search_all_assignments(self, - request: Union[reservation.SearchAllAssignmentsRequest, dict] = None, - *, - parent: str = None, - query: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchAllAssignmentsPager: - r"""Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (str): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, query]) - 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 reservation.SearchAllAssignmentsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.SearchAllAssignmentsRequest): - request = reservation.SearchAllAssignmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.search_all_assignments] - - # 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.SearchAllAssignmentsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def move_assignment(self, - request: Union[reservation.MoveAssignmentRequest, dict] = None, - *, - name: str = None, - destination_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.Assignment: - r"""Moves an assignment under a new reservation. - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]): - The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. - name (str): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - destination_id (str): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - - This corresponds to the ``destination_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.bigquery_reservation_v1.types.Assignment: - A Assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, destination_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 reservation.MoveAssignmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.MoveAssignmentRequest): - request = reservation.MoveAssignmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if destination_id is not None: - request.destination_id = destination_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.move_assignment] - - # 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_bi_reservation(self, - request: Union[reservation.GetBiReservationRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.BiReservation: - r"""Retrieves a BI reservation. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]): - The request object. A request to get a singleton BI - reservation. - name (str): - Required. Name of the requested reservation, for - example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - - 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.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a reservation.GetBiReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.GetBiReservationRequest): - request = reservation.GetBiReservationRequest(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_bi_reservation] - - # 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_bi_reservation(self, - request: Union[reservation.UpdateBiReservationRequest, dict] = None, - *, - bi_reservation: reservation.BiReservation = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> reservation.BiReservation: - r"""Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]): - The request object. A request to update a BI - reservation. - bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): - A reservation to update. - This corresponds to the ``bi_reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - A list of fields to be updated in - this request. - - 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.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([bi_reservation, 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 reservation.UpdateBiReservationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, reservation.UpdateBiReservationRequest): - request = reservation.UpdateBiReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if bi_reservation is not None: - request.bi_reservation = bi_reservation - 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_bi_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("bi_reservation.name", request.bi_reservation.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self): - 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() - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-bigquery-reservation", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "ReservationServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py deleted file mode 100644 index bad68017..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py +++ /dev/null @@ -1,628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.bigquery_reservation_v1.types import reservation - - -class ListReservationsPager: - """A pager for iterating through ``list_reservations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``reservations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListReservations`` requests and continue to iterate - through the ``reservations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` - 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[..., reservation.ListReservationsResponse], - request: reservation.ListReservationsRequest, - response: reservation.ListReservationsResponse, - *, - 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.bigquery_reservation_v1.types.ListReservationsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): - 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 = reservation.ListReservationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListReservationsResponse]: - 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[reservation.Reservation]: - for page in self.pages: - yield from page.reservations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListReservationsAsyncPager: - """A pager for iterating through ``list_reservations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``reservations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListReservations`` requests and continue to iterate - through the ``reservations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` - 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[reservation.ListReservationsResponse]], - request: reservation.ListReservationsRequest, - response: reservation.ListReservationsResponse, - *, - 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.bigquery_reservation_v1.types.ListReservationsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): - 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 = reservation.ListReservationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListReservationsResponse]: - 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[reservation.Reservation]: - async def async_generator(): - async for page in self.pages: - for response in page.reservations: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCapacityCommitmentsPager: - """A pager for iterating through ``list_capacity_commitments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``capacity_commitments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListCapacityCommitments`` requests and continue to iterate - through the ``capacity_commitments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` - 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[..., reservation.ListCapacityCommitmentsResponse], - request: reservation.ListCapacityCommitmentsRequest, - response: reservation.ListCapacityCommitmentsResponse, - *, - 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.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): - 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 = reservation.ListCapacityCommitmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListCapacityCommitmentsResponse]: - 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[reservation.CapacityCommitment]: - for page in self.pages: - yield from page.capacity_commitments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCapacityCommitmentsAsyncPager: - """A pager for iterating through ``list_capacity_commitments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``capacity_commitments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListCapacityCommitments`` requests and continue to iterate - through the ``capacity_commitments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` - 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[reservation.ListCapacityCommitmentsResponse]], - request: reservation.ListCapacityCommitmentsRequest, - response: reservation.ListCapacityCommitmentsResponse, - *, - 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.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): - 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 = reservation.ListCapacityCommitmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListCapacityCommitmentsResponse]: - 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[reservation.CapacityCommitment]: - async def async_generator(): - async for page in self.pages: - for response in page.capacity_commitments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListAssignmentsPager: - """A pager for iterating through ``list_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` - 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[..., reservation.ListAssignmentsResponse], - request: reservation.ListAssignmentsRequest, - response: reservation.ListAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.ListAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): - 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 = reservation.ListAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListAssignmentsResponse]: - 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[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListAssignmentsAsyncPager: - """A pager for iterating through ``list_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` - 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[reservation.ListAssignmentsResponse]], - request: reservation.ListAssignmentsRequest, - response: reservation.ListAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.ListAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): - 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 = reservation.ListAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListAssignmentsResponse]: - 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[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAssignmentsPager: - """A pager for iterating through ``search_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``SearchAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` - 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[..., reservation.SearchAssignmentsResponse], - request: reservation.SearchAssignmentsRequest, - response: reservation.SearchAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.SearchAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): - 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 = reservation.SearchAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.SearchAssignmentsResponse]: - 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[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAssignmentsAsyncPager: - """A pager for iterating through ``search_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``SearchAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` - 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[reservation.SearchAssignmentsResponse]], - request: reservation.SearchAssignmentsRequest, - response: reservation.SearchAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.SearchAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): - 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 = reservation.SearchAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.SearchAssignmentsResponse]: - 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[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAllAssignmentsPager: - """A pager for iterating through ``search_all_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``SearchAllAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` - 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[..., reservation.SearchAllAssignmentsResponse], - request: reservation.SearchAllAssignmentsRequest, - response: reservation.SearchAllAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): - 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 = reservation.SearchAllAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.SearchAllAssignmentsResponse]: - 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[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAllAssignmentsAsyncPager: - """A pager for iterating through ``search_all_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``SearchAllAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` - 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[reservation.SearchAllAssignmentsResponse]], - request: reservation.SearchAllAssignmentsRequest, - response: reservation.SearchAllAssignmentsResponse, - *, - 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.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): - 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 = reservation.SearchAllAssignmentsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.SearchAllAssignmentsResponse]: - 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[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - 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/bigquery_reservation_v1/services/reservation_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py deleted file mode 100644 index 4fadd3a7..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import ReservationServiceTransport -from .grpc import ReservationServiceGrpcTransport -from .grpc_asyncio import ReservationServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[ReservationServiceTransport]] -_transport_registry['grpc'] = ReservationServiceGrpcTransport -_transport_registry['grpc_asyncio'] = ReservationServiceGrpcAsyncIOTransport - -__all__ = ( - 'ReservationServiceTransport', - 'ReservationServiceGrpcTransport', - 'ReservationServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py deleted file mode 100644 index 5276f0ed..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py +++ /dev/null @@ -1,516 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.protobuf import empty_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-bigquery-reservation', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class ReservationServiceTransport(abc.ABC): - """Abstract transport class for ReservationService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'bigqueryreservation.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials 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 - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_reservation: gapic_v1.method.wrap_method( - self.create_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.list_reservations: gapic_v1.method.wrap_method( - self.list_reservations, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_reservation: gapic_v1.method.wrap_method( - self.get_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_reservation: gapic_v1.method.wrap_method( - self.delete_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_reservation: gapic_v1.method.wrap_method( - self.update_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.create_capacity_commitment: gapic_v1.method.wrap_method( - self.create_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_capacity_commitments: gapic_v1.method.wrap_method( - self.list_capacity_commitments, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_capacity_commitment: gapic_v1.method.wrap_method( - self.get_capacity_commitment, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_capacity_commitment: gapic_v1.method.wrap_method( - self.delete_capacity_commitment, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_capacity_commitment: gapic_v1.method.wrap_method( - self.update_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.split_capacity_commitment: gapic_v1.method.wrap_method( - self.split_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.merge_capacity_commitments: gapic_v1.method.wrap_method( - self.merge_capacity_commitments, - default_timeout=300.0, - client_info=client_info, - ), - self.create_assignment: gapic_v1.method.wrap_method( - self.create_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_assignments: gapic_v1.method.wrap_method( - self.list_assignments, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_assignment: gapic_v1.method.wrap_method( - self.delete_assignment, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.search_assignments: gapic_v1.method.wrap_method( - self.search_assignments, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.search_all_assignments: gapic_v1.method.wrap_method( - self.search_all_assignments, - default_timeout=None, - client_info=client_info, - ), - self.move_assignment: gapic_v1.method.wrap_method( - self.move_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.get_bi_reservation: gapic_v1.method.wrap_method( - self.get_bi_reservation, - 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=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_bi_reservation: gapic_v1.method.wrap_method( - self.update_bi_reservation, - default_timeout=300.0, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - Union[ - gcbr_reservation.Reservation, - Awaitable[gcbr_reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - Union[ - reservation.ListReservationsResponse, - Awaitable[reservation.ListReservationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - Union[ - reservation.Reservation, - Awaitable[reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - Union[ - gcbr_reservation.Reservation, - Awaitable[gcbr_reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - Union[ - reservation.ListCapacityCommitmentsResponse, - Awaitable[reservation.ListCapacityCommitmentsResponse] - ]]: - raise NotImplementedError() - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - Union[ - reservation.SplitCapacityCommitmentResponse, - Awaitable[reservation.SplitCapacityCommitmentResponse] - ]]: - raise NotImplementedError() - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - Union[ - reservation.Assignment, - Awaitable[reservation.Assignment] - ]]: - raise NotImplementedError() - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - Union[ - reservation.ListAssignmentsResponse, - Awaitable[reservation.ListAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - Union[ - reservation.SearchAssignmentsResponse, - Awaitable[reservation.SearchAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - Union[ - reservation.SearchAllAssignmentsResponse, - Awaitable[reservation.SearchAllAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - Union[ - reservation.Assignment, - Awaitable[reservation.Assignment] - ]]: - raise NotImplementedError() - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - Union[ - reservation.BiReservation, - Awaitable[reservation.BiReservation] - ]]: - raise NotImplementedError() - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - Union[ - reservation.BiReservation, - Awaitable[reservation.BiReservation] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'ReservationServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py deleted file mode 100644 index ebe58756..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py +++ /dev/null @@ -1,926 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import gapic_v1 # type: ignore -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.protobuf import empty_pb2 # type: ignore -from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO - - -class ReservationServiceGrpcTransport(ReservationServiceTransport): - """gRPC backend transport for ReservationService. - - This API allows users to manage their flat-rate BigQuery - reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - - 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 = 'bigqueryreservation.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or 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, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'bigqueryreservation.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - gcbr_reservation.Reservation]: - r"""Return a callable for the create reservation method over gRPC. - - Creates a new reservation resource. - - Returns: - Callable[[~.CreateReservationRequest], - ~.Reservation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['create_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', - request_serializer=gcbr_reservation.CreateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['create_reservation'] - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - reservation.ListReservationsResponse]: - r"""Return a callable for the list reservations method over gRPC. - - Lists all the reservations for the project in the - specified location. - - Returns: - Callable[[~.ListReservationsRequest], - ~.ListReservationsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservations' not in self._stubs: - self._stubs['list_reservations'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', - request_serializer=reservation.ListReservationsRequest.serialize, - response_deserializer=reservation.ListReservationsResponse.deserialize, - ) - return self._stubs['list_reservations'] - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - reservation.Reservation]: - r"""Return a callable for the get reservation method over gRPC. - - Returns information about the reservation. - - Returns: - Callable[[~.GetReservationRequest], - ~.Reservation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['get_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', - request_serializer=reservation.GetReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['get_reservation'] - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete reservation method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationRequest], - ~.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_reservation' not in self._stubs: - self._stubs['delete_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', - request_serializer=reservation.DeleteReservationRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation'] - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - gcbr_reservation.Reservation]: - r"""Return a callable for the update reservation method over gRPC. - - Updates an existing reservation resource. - - Returns: - Callable[[~.UpdateReservationRequest], - ~.Reservation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['update_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', - request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['update_reservation'] - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the create capacity commitment method over gRPC. - - Creates a new capacity commitment resource. - - Returns: - Callable[[~.CreateCapacityCommitmentRequest], - ~.CapacityCommitment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['create_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', - request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['create_capacity_commitment'] - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - reservation.ListCapacityCommitmentsResponse]: - r"""Return a callable for the list capacity commitments method over gRPC. - - Lists all the capacity commitments for the admin - project. - - Returns: - Callable[[~.ListCapacityCommitmentsRequest], - ~.ListCapacityCommitmentsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitments' not in self._stubs: - self._stubs['list_capacity_commitments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', - request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, - ) - return self._stubs['list_capacity_commitments'] - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the get capacity commitment method over gRPC. - - Returns information about the capacity commitment. - - Returns: - Callable[[~.GetCapacityCommitmentRequest], - ~.CapacityCommitment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['get_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', - request_serializer=reservation.GetCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['get_capacity_commitment'] - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete capacity commitment method over gRPC. - - Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.DeleteCapacityCommitmentRequest], - ~.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_capacity_commitment' not in self._stubs: - self._stubs['delete_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', - request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_capacity_commitment'] - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the update capacity commitment method over gRPC. - - Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.UpdateCapacityCommitmentRequest], - ~.CapacityCommitment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['update_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', - request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['update_capacity_commitment'] - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - reservation.SplitCapacityCommitmentResponse]: - r"""Return a callable for the split capacity commitment method over gRPC. - - Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you would change the plan of the first one to - ``FLEX`` and then delete it. - - Returns: - Callable[[~.SplitCapacityCommitmentRequest], - ~.SplitCapacityCommitmentResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'split_capacity_commitment' not in self._stubs: - self._stubs['split_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', - request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, - response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, - ) - return self._stubs['split_capacity_commitment'] - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the merge capacity commitments method over gRPC. - - Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.MergeCapacityCommitmentsRequest], - ~.CapacityCommitment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'merge_capacity_commitments' not in self._stubs: - self._stubs['merge_capacity_commitments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', - request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['merge_capacity_commitments'] - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - reservation.Assignment]: - r"""Return a callable for the create assignment method over gRPC. - - Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Returns: - Callable[[~.CreateAssignmentRequest], - ~.Assignment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_assignment' not in self._stubs: - self._stubs['create_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', - request_serializer=reservation.CreateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['create_assignment'] - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - reservation.ListAssignmentsResponse]: - r"""Return a callable for the list assignments method over gRPC. - - Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.ListAssignmentsRequest], - ~.ListAssignmentsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_assignments' not in self._stubs: - self._stubs['list_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', - request_serializer=reservation.ListAssignmentsRequest.serialize, - response_deserializer=reservation.ListAssignmentsResponse.deserialize, - ) - return self._stubs['list_assignments'] - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete assignment method over gRPC. - - Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Returns: - Callable[[~.DeleteAssignmentRequest], - ~.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_assignment' not in self._stubs: - self._stubs['delete_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', - request_serializer=reservation.DeleteAssignmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_assignment'] - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - reservation.SearchAssignmentsResponse]: - r"""Return a callable for the search assignments method over gRPC. - - Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.SearchAssignmentsRequest], - ~.SearchAssignmentsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_assignments' not in self._stubs: - self._stubs['search_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', - request_serializer=reservation.SearchAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAssignmentsResponse.deserialize, - ) - return self._stubs['search_assignments'] - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - reservation.SearchAllAssignmentsResponse]: - r"""Return a callable for the search all assignments method over gRPC. - - Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Returns: - Callable[[~.SearchAllAssignmentsRequest], - ~.SearchAllAssignmentsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_all_assignments' not in self._stubs: - self._stubs['search_all_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', - request_serializer=reservation.SearchAllAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, - ) - return self._stubs['search_all_assignments'] - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - reservation.Assignment]: - r"""Return a callable for the move assignment method over gRPC. - - Moves an assignment under a new reservation. - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Returns: - Callable[[~.MoveAssignmentRequest], - ~.Assignment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'move_assignment' not in self._stubs: - self._stubs['move_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', - request_serializer=reservation.MoveAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['move_assignment'] - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - reservation.BiReservation]: - r"""Return a callable for the get bi reservation method over gRPC. - - Retrieves a BI reservation. - - Returns: - Callable[[~.GetBiReservationRequest], - ~.BiReservation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: - self._stubs['get_bi_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', - request_serializer=reservation.GetBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['get_bi_reservation'] - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - reservation.BiReservation]: - r"""Return a callable for the update bi reservation method over gRPC. - - Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Returns: - Callable[[~.UpdateBiReservationRequest], - ~.BiReservation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: - self._stubs['update_bi_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', - request_serializer=reservation.UpdateBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['update_bi_reservation'] - - def close(self): - self.grpc_channel.close() - -__all__ = ( - 'ReservationServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py deleted file mode 100644 index 10dd8d1b..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,931 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.protobuf import empty_pb2 # type: ignore -from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import ReservationServiceGrpcTransport - - -class ReservationServiceGrpcAsyncIOTransport(ReservationServiceTransport): - """gRPC AsyncIO backend transport for ReservationService. - - This API allows users to manage their flat-rate BigQuery - reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - - 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 = 'bigqueryreservation.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'bigqueryreservation.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or 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, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - Awaitable[gcbr_reservation.Reservation]]: - r"""Return a callable for the create reservation method over gRPC. - - Creates a new reservation resource. - - Returns: - Callable[[~.CreateReservationRequest], - Awaitable[~.Reservation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['create_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', - request_serializer=gcbr_reservation.CreateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['create_reservation'] - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - Awaitable[reservation.ListReservationsResponse]]: - r"""Return a callable for the list reservations method over gRPC. - - Lists all the reservations for the project in the - specified location. - - Returns: - Callable[[~.ListReservationsRequest], - Awaitable[~.ListReservationsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservations' not in self._stubs: - self._stubs['list_reservations'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', - request_serializer=reservation.ListReservationsRequest.serialize, - response_deserializer=reservation.ListReservationsResponse.deserialize, - ) - return self._stubs['list_reservations'] - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - Awaitable[reservation.Reservation]]: - r"""Return a callable for the get reservation method over gRPC. - - Returns information about the reservation. - - Returns: - Callable[[~.GetReservationRequest], - Awaitable[~.Reservation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['get_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', - request_serializer=reservation.GetReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['get_reservation'] - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete reservation method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationRequest], - 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_reservation' not in self._stubs: - self._stubs['delete_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', - request_serializer=reservation.DeleteReservationRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation'] - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - Awaitable[gcbr_reservation.Reservation]]: - r"""Return a callable for the update reservation method over gRPC. - - Updates an existing reservation resource. - - Returns: - Callable[[~.UpdateReservationRequest], - Awaitable[~.Reservation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_reservation' not in self._stubs: - self._stubs['update_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', - request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['update_reservation'] - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the create capacity commitment method over gRPC. - - Creates a new capacity commitment resource. - - Returns: - Callable[[~.CreateCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['create_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', - request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['create_capacity_commitment'] - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - Awaitable[reservation.ListCapacityCommitmentsResponse]]: - r"""Return a callable for the list capacity commitments method over gRPC. - - Lists all the capacity commitments for the admin - project. - - Returns: - Callable[[~.ListCapacityCommitmentsRequest], - Awaitable[~.ListCapacityCommitmentsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitments' not in self._stubs: - self._stubs['list_capacity_commitments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', - request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, - ) - return self._stubs['list_capacity_commitments'] - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the get capacity commitment method over gRPC. - - Returns information about the capacity commitment. - - Returns: - Callable[[~.GetCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['get_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', - request_serializer=reservation.GetCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['get_capacity_commitment'] - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete capacity commitment method over gRPC. - - Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.DeleteCapacityCommitmentRequest], - 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_capacity_commitment' not in self._stubs: - self._stubs['delete_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', - request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_capacity_commitment'] - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the update capacity commitment method over gRPC. - - Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.UpdateCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_capacity_commitment' not in self._stubs: - self._stubs['update_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', - request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['update_capacity_commitment'] - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - Awaitable[reservation.SplitCapacityCommitmentResponse]]: - r"""Return a callable for the split capacity commitment method over gRPC. - - Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you would change the plan of the first one to - ``FLEX`` and then delete it. - - Returns: - Callable[[~.SplitCapacityCommitmentRequest], - Awaitable[~.SplitCapacityCommitmentResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'split_capacity_commitment' not in self._stubs: - self._stubs['split_capacity_commitment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', - request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, - response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, - ) - return self._stubs['split_capacity_commitment'] - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the merge capacity commitments method over gRPC. - - Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.MergeCapacityCommitmentsRequest], - Awaitable[~.CapacityCommitment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'merge_capacity_commitments' not in self._stubs: - self._stubs['merge_capacity_commitments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', - request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['merge_capacity_commitments'] - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - Awaitable[reservation.Assignment]]: - r"""Return a callable for the create assignment method over gRPC. - - Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Returns: - Callable[[~.CreateAssignmentRequest], - Awaitable[~.Assignment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_assignment' not in self._stubs: - self._stubs['create_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', - request_serializer=reservation.CreateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['create_assignment'] - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - Awaitable[reservation.ListAssignmentsResponse]]: - r"""Return a callable for the list assignments method over gRPC. - - Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.ListAssignmentsRequest], - Awaitable[~.ListAssignmentsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_assignments' not in self._stubs: - self._stubs['list_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', - request_serializer=reservation.ListAssignmentsRequest.serialize, - response_deserializer=reservation.ListAssignmentsResponse.deserialize, - ) - return self._stubs['list_assignments'] - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete assignment method over gRPC. - - Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Returns: - Callable[[~.DeleteAssignmentRequest], - 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_assignment' not in self._stubs: - self._stubs['delete_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', - request_serializer=reservation.DeleteAssignmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_assignment'] - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - Awaitable[reservation.SearchAssignmentsResponse]]: - r"""Return a callable for the search assignments method over gRPC. - - Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.SearchAssignmentsRequest], - Awaitable[~.SearchAssignmentsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_assignments' not in self._stubs: - self._stubs['search_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', - request_serializer=reservation.SearchAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAssignmentsResponse.deserialize, - ) - return self._stubs['search_assignments'] - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - Awaitable[reservation.SearchAllAssignmentsResponse]]: - r"""Return a callable for the search all assignments method over gRPC. - - Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Returns: - Callable[[~.SearchAllAssignmentsRequest], - Awaitable[~.SearchAllAssignmentsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_all_assignments' not in self._stubs: - self._stubs['search_all_assignments'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', - request_serializer=reservation.SearchAllAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, - ) - return self._stubs['search_all_assignments'] - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - Awaitable[reservation.Assignment]]: - r"""Return a callable for the move assignment method over gRPC. - - Moves an assignment under a new reservation. - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Returns: - Callable[[~.MoveAssignmentRequest], - Awaitable[~.Assignment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'move_assignment' not in self._stubs: - self._stubs['move_assignment'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', - request_serializer=reservation.MoveAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['move_assignment'] - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - Awaitable[reservation.BiReservation]]: - r"""Return a callable for the get bi reservation method over gRPC. - - Retrieves a BI reservation. - - Returns: - Callable[[~.GetBiReservationRequest], - Awaitable[~.BiReservation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: - self._stubs['get_bi_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', - request_serializer=reservation.GetBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['get_bi_reservation'] - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - Awaitable[reservation.BiReservation]]: - r"""Return a callable for the update bi reservation method over gRPC. - - Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Returns: - Callable[[~.UpdateBiReservationRequest], - Awaitable[~.BiReservation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_bi_reservation' not in self._stubs: - self._stubs['update_bi_reservation'] = self.grpc_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', - request_serializer=reservation.UpdateBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['update_bi_reservation'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'ReservationServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py deleted file mode 100644 index 34a4a055..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/__init__.py +++ /dev/null @@ -1,80 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .reservation import ( - Assignment, - BiReservation, - CapacityCommitment, - CreateAssignmentRequest, - CreateCapacityCommitmentRequest, - CreateReservationRequest, - DeleteAssignmentRequest, - DeleteCapacityCommitmentRequest, - DeleteReservationRequest, - GetBiReservationRequest, - GetCapacityCommitmentRequest, - GetReservationRequest, - ListAssignmentsRequest, - ListAssignmentsResponse, - ListCapacityCommitmentsRequest, - ListCapacityCommitmentsResponse, - ListReservationsRequest, - ListReservationsResponse, - MergeCapacityCommitmentsRequest, - MoveAssignmentRequest, - Reservation, - SearchAllAssignmentsRequest, - SearchAllAssignmentsResponse, - SearchAssignmentsRequest, - SearchAssignmentsResponse, - SplitCapacityCommitmentRequest, - SplitCapacityCommitmentResponse, - UpdateBiReservationRequest, - UpdateCapacityCommitmentRequest, - UpdateReservationRequest, -) - -__all__ = ( - 'Assignment', - 'BiReservation', - 'CapacityCommitment', - 'CreateAssignmentRequest', - 'CreateCapacityCommitmentRequest', - 'CreateReservationRequest', - 'DeleteAssignmentRequest', - 'DeleteCapacityCommitmentRequest', - 'DeleteReservationRequest', - 'GetBiReservationRequest', - 'GetCapacityCommitmentRequest', - 'GetReservationRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'MergeCapacityCommitmentsRequest', - 'MoveAssignmentRequest', - 'Reservation', - 'SearchAllAssignmentsRequest', - 'SearchAllAssignmentsResponse', - 'SearchAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'UpdateBiReservationRequest', - 'UpdateCapacityCommitmentRequest', - 'UpdateReservationRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py b/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py deleted file mode 100644 index f6190c89..00000000 --- a/owl-bot-staging/v1/google/cloud/bigquery_reservation_v1/types/reservation.py +++ /dev/null @@ -1,1023 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.bigquery.reservation.v1', - manifest={ - 'Reservation', - 'CapacityCommitment', - 'CreateReservationRequest', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'GetReservationRequest', - 'DeleteReservationRequest', - 'UpdateReservationRequest', - 'CreateCapacityCommitmentRequest', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'GetCapacityCommitmentRequest', - 'DeleteCapacityCommitmentRequest', - 'UpdateCapacityCommitmentRequest', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'MergeCapacityCommitmentsRequest', - 'Assignment', - 'CreateAssignmentRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'DeleteAssignmentRequest', - 'SearchAssignmentsRequest', - 'SearchAllAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SearchAllAssignmentsResponse', - 'MoveAssignmentRequest', - 'BiReservation', - 'GetBiReservationRequest', - 'UpdateBiReservationRequest', - }, -) - - -class Reservation(proto.Message): - r"""A reservation is a mechanism used to guarantee slots to - users. - - Attributes: - name (str): - The resource name of the reservation, e.g., - ``projects/*/locations/*/reservations/team1-prod``. - slot_capacity (int): - Minimum slots available to this reservation. A slot is a - unit of computational power in BigQuery, and serves as the - unit of parallelism. - - Queries using this reservation might use more slots during - runtime if ignore_idle_slots is set to false. - - If the new reservation's slot capacity exceed the parent's - slot capacity or if total slot capacity of the new - reservation and its siblings exceeds the parent's slot - capacity, the request will fail with - ``google.rpc.Code.RESOURCE_EXHAUSTED``. - ignore_idle_slots (bool): - If false, any query or pipeline job using this reservation - will use idle slots from other reservations within the same - admin project. If true, a query or pipeline job using this - reservation will execute with the slot capacity specified in - the slot_capacity field at most. - creation_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Creation time of the - reservation. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Last update time of the - reservation. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - slot_capacity = proto.Field( - proto.INT64, - number=2, - ) - ignore_idle_slots = proto.Field( - proto.BOOL, - number=4, - ) - creation_time = proto.Field( - proto.MESSAGE, - number=8, - message=timestamp_pb2.Timestamp, - ) - update_time = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - - -class CapacityCommitment(proto.Message): - r"""Capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period - of usage. Annual commitments renew by default. Commitments can - be removed after their commitment end time passes. - - In order to remove annual commitment, its plan needs to be - changed to monthly or flex first. - - A capacity commitment resource exists as a child resource of the - admin project. - - Attributes: - name (str): - Output only. The resource name of the capacity commitment, - e.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - slot_count (int): - Number of slots in this commitment. - plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - Capacity commitment commitment plan. - state (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State): - Output only. State of the commitment. - commitment_start_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The start of the current - commitment period. It is applicable only for - ACTIVE capacity commitments. - commitment_end_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The end of the current - commitment period. It is applicable only for - ACTIVE capacity commitments. - failure_status (google.rpc.status_pb2.Status): - Output only. For FAILED commitment plan, - provides the reason of failure. - renewal_plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - The plan this capacity commitment is converted to after - commitment_end_time passes. Once the plan is changed, - committed period is extended according to commitment plan. - Only applicable for ANNUAL and TRIAL commitments. - """ - class CommitmentPlan(proto.Enum): - r"""Commitment plan defines the current committed period. - Capacity commitment cannot be deleted during it's committed - period. - """ - COMMITMENT_PLAN_UNSPECIFIED = 0 - FLEX = 3 - TRIAL = 5 - MONTHLY = 2 - ANNUAL = 4 - - class State(proto.Enum): - r"""Capacity commitment can either become ACTIVE right away or - transition from PENDING to ACTIVE or FAILED. - """ - STATE_UNSPECIFIED = 0 - PENDING = 1 - ACTIVE = 2 - FAILED = 3 - - name = proto.Field( - proto.STRING, - number=1, - ) - slot_count = proto.Field( - proto.INT64, - number=2, - ) - plan = proto.Field( - proto.ENUM, - number=3, - enum=CommitmentPlan, - ) - state = proto.Field( - proto.ENUM, - number=4, - enum=State, - ) - commitment_start_time = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - commitment_end_time = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - failure_status = proto.Field( - proto.MESSAGE, - number=7, - message=status_pb2.Status, - ) - renewal_plan = proto.Field( - proto.ENUM, - number=8, - enum=CommitmentPlan, - ) - - -class CreateReservationRequest(proto.Message): - r"""The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - - Attributes: - parent (str): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - reservation_id (str): - The reservation ID. This field must only - contain lower case alphanumeric characters or - dash. Max length is 64 characters. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Definition of the new reservation to create. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - reservation_id = proto.Field( - proto.STRING, - number=2, - ) - reservation = proto.Field( - proto.MESSAGE, - number=3, - message='Reservation', - ) - - -class ListReservationsRequest(proto.Message): - r"""The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Attributes: - parent (str): - Required. The parent resource name containing project and - location, e.g.: ``projects/myproject/locations/US`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListReservationsResponse(proto.Message): - r"""The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Attributes: - reservations (Sequence[google.cloud.bigquery_reservation_v1.types.Reservation]): - List of reservations visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - reservations = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Reservation', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetReservationRequest(proto.Message): - r"""The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - - Attributes: - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteReservationRequest(proto.Message): - r"""The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - - Attributes: - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateReservationRequest(proto.Message): - r"""The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - - Attributes: - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Content of the reservation to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of fields to - be updated. - """ - - reservation = proto.Field( - proto.MESSAGE, - number=1, - message='Reservation', - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class CreateCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - - Attributes: - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to create. - enforce_single_admin_project_per_org (bool): - If true, fail the request if another project - in the organization has a capacity commitment. - capacity_commitment_id (str): - The optional capacity commitment ID. Capacity - commitment name will be generated automatically - if this field is empty. This field must only - contain lower case alphanumeric characters or - dash. Max length is 64 characters. - NOTE: this ID won't be kept if the capacity - commitment is split or merged. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - capacity_commitment = proto.Field( - proto.MESSAGE, - number=2, - message='CapacityCommitment', - ) - enforce_single_admin_project_per_org = proto.Field( - proto.BOOL, - number=4, - ) - capacity_commitment_id = proto.Field( - proto.STRING, - number=5, - ) - - -class ListCapacityCommitmentsRequest(proto.Message): - r"""The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Attributes: - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - page_size (int): - The maximum number of items to return. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListCapacityCommitmentsResponse(proto.Message): - r"""The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Attributes: - capacity_commitments (Sequence[google.cloud.bigquery_reservation_v1.types.CapacityCommitment]): - List of capacity commitments visible to the - user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - capacity_commitments = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - - Attributes: - name (str): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - - Attributes: - name (str): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - force (bool): - Can be used to force delete commitments even - if assignments exist. Deleting commitments with - assignments may cause queries to fail if they no - longer have access to slots. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - force = proto.Field( - proto.BOOL, - number=3, - ) - - -class UpdateCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - - Attributes: - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of fields to - be updated. - """ - - capacity_commitment = proto.Field( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class SplitCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - Attributes: - name (str): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - slot_count (int): - Number of slots in the capacity commitment - after the split. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - slot_count = proto.Field( - proto.INT64, - number=2, - ) - - -class SplitCapacityCommitmentResponse(proto.Message): - r"""The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - Attributes: - first (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - First capacity commitment, result of a split. - second (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Second capacity commitment, result of a - split. - """ - - first = proto.Field( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - second = proto.Field( - proto.MESSAGE, - number=2, - message='CapacityCommitment', - ) - - -class MergeCapacityCommitmentsRequest(proto.Message): - r"""The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - - Attributes: - parent (str): - Parent resource that identifies admin project and location - e.g., ``projects/myproject/locations/us`` - capacity_commitment_ids (Sequence[str]): - Ids of capacity commitments to merge. - These capacity commitments must exist under - admin project and location specified in the - parent. - ID is the last portion of capacity commitment - name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - capacity_commitment_ids = proto.RepeatedField( - proto.STRING, - number=2, - ) - - -class Assignment(proto.Message): - r"""A Assignment allows a project to submit jobs - of a certain type using slots from the specified reservation. - - Attributes: - name (str): - Output only. Name of the resource. E.g.: - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123``. - assignee (str): - The resource which will use the reservation. E.g. - ``projects/myproject``, ``folders/123``, or - ``organizations/456``. - job_type (google.cloud.bigquery_reservation_v1.types.Assignment.JobType): - Which type of jobs will use the reservation. - state (google.cloud.bigquery_reservation_v1.types.Assignment.State): - Output only. State of the assignment. - """ - class JobType(proto.Enum): - r"""Types of job, which could be specified when using the - reservation. - """ - JOB_TYPE_UNSPECIFIED = 0 - PIPELINE = 1 - QUERY = 2 - ML_EXTERNAL = 3 - - class State(proto.Enum): - r"""Assignment will remain in PENDING state if no active capacity - commitment is present. It will become ACTIVE when some capacity - commitment becomes active. - """ - STATE_UNSPECIFIED = 0 - PENDING = 1 - ACTIVE = 2 - - name = proto.Field( - proto.STRING, - number=1, - ) - assignee = proto.Field( - proto.STRING, - number=4, - ) - job_type = proto.Field( - proto.ENUM, - number=3, - enum=JobType, - ) - state = proto.Field( - proto.ENUM, - number=6, - enum=State, - ) - - -class CreateAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The parent resource name of the assignment E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Assignment resource to create. - assignment_id (str): - The optional assignment ID. Assignment name - will be generated automatically if this field is - empty. This field must only contain lower case - alphanumeric characters or dash. Max length is - 64 characters. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - assignment = proto.Field( - proto.MESSAGE, - number=2, - message='Assignment', - ) - assignment_id = proto.Field( - proto.STRING, - number=4, - ) - - -class ListAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Attributes: - parent (str): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Attributes: - assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class DeleteAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" permission is - required on the related assignee. - - Attributes: - name (str): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class SearchAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The resource name of the admin project(containing - project and location), e.g.: - ``projects/myproject/locations/US``. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - query = proto.Field( - proto.STRING, - number=2, - ) - page_size = proto.Field( - proto.INT32, - number=3, - ) - page_token = proto.Field( - proto.STRING, - number=4, - ) - - -class SearchAllAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - query = proto.Field( - proto.STRING, - number=2, - ) - page_size = proto.Field( - proto.INT32, - number=3, - ) - page_token = proto.Field( - proto.STRING, - number=4, - ) - - -class SearchAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Attributes: - assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class SearchAllAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - Attributes: - assignments (Sequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class MoveAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" permission is - required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are required on - the related assignee. - - Attributes: - name (str): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - destination_id (str): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - destination_id = proto.Field( - proto.STRING, - number=3, - ) - - -class BiReservation(proto.Message): - r"""Represents a BI Reservation. - - Attributes: - name (str): - The resource name of the singleton BI reservation. - Reservation names have the form - ``projects/{project_id}/locations/{location_id}/biReservation``. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The last update timestamp of a - reservation. - size (int): - Size of a reservation, in bytes. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - size = proto.Field( - proto.INT64, - number=4, - ) - - -class GetBiReservationRequest(proto.Message): - r"""A request to get a singleton BI reservation. - - Attributes: - name (str): - Required. Name of the requested reservation, for example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateBiReservationRequest(proto.Message): - r"""A request to update a BI reservation. - - Attributes: - bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): - A reservation to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - A list of fields to be updated in this - request. - """ - - bi_reservation = proto.Field( - proto.MESSAGE, - number=1, - message='BiReservation', - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b485..00000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 0fae27af..00000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/bigquery_reservation_v1/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py deleted file mode 100644 index c7cb6030..00000000 --- a/owl-bot-staging/v1/scripts/fixup_bigquery_reservation_v1_keywords.py +++ /dev/null @@ -1,195 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class bigquery_reservationCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_assignment': ('parent', 'assignment', 'assignment_id', ), - 'create_capacity_commitment': ('parent', 'capacity_commitment', 'enforce_single_admin_project_per_org', 'capacity_commitment_id', ), - 'create_reservation': ('parent', 'reservation_id', 'reservation', ), - 'delete_assignment': ('name', ), - 'delete_capacity_commitment': ('name', 'force', ), - 'delete_reservation': ('name', ), - 'get_bi_reservation': ('name', ), - 'get_capacity_commitment': ('name', ), - 'get_reservation': ('name', ), - 'list_assignments': ('parent', 'page_size', 'page_token', ), - 'list_capacity_commitments': ('parent', 'page_size', 'page_token', ), - 'list_reservations': ('parent', 'page_size', 'page_token', ), - 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', ), - 'move_assignment': ('name', 'destination_id', ), - 'search_all_assignments': ('parent', 'query', 'page_size', 'page_token', ), - 'search_assignments': ('parent', 'query', 'page_size', 'page_token', ), - 'split_capacity_commitment': ('name', 'slot_count', ), - 'update_bi_reservation': ('bi_reservation', 'update_mask', ), - 'update_capacity_commitment': ('capacity_commitment', 'update_mask', ), - 'update_reservation': ('reservation', '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=bigquery_reservationCallTransformer(), -): - """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 bigquery_reservation client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index 332ecf4f..00000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-bigquery-reservation', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py deleted file mode 100644 index 683f204c..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py +++ /dev/null @@ -1,6795 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceAsyncClient -from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceClient -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.services.reservation_service import transports -from google.cloud.bigquery_reservation_v1.services.reservation_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.oauth2 import service_account -from google.protobuf import any_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert ReservationServiceClient._get_default_mtls_endpoint(None) is None - assert ReservationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - ReservationServiceClient, - ReservationServiceAsyncClient, -]) -def test_reservation_service_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'bigqueryreservation.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.ReservationServiceGrpcTransport, "grpc"), - (transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_reservation_service_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - ReservationServiceClient, - ReservationServiceAsyncClient, -]) -def test_reservation_service_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'bigqueryreservation.googleapis.com:443' - - -def test_reservation_service_client_get_transport_class(): - transport = ReservationServiceClient.get_transport_class() - available_transports = [ - transports.ReservationServiceGrpcTransport, - ] - assert transport in available_transports - - transport = ReservationServiceClient.get_transport_class("grpc") - assert transport == transports.ReservationServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) -def test_reservation_service_client_client_options(client_class, transport_class, transport_name): - # Check that if channel is provided we won't create a new one. - with mock.patch.object(ReservationServiceClient, '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(ReservationServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "true"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "false"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_reservation_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_reservation_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_reservation_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_reservation_service_client_client_options_from_dict(): - with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = ReservationServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_create_reservation(transport: str = 'grpc', request_type=gcbr_reservation.CreateReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - ) - response = client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.CreateReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -def test_create_reservation_from_dict(): - test_create_reservation(request_type=dict) - - -def test_create_reservation_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 = ReservationServiceClient( - 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_reservation), - '__call__') as call: - client.create_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.CreateReservationRequest() - - -@pytest.mark.asyncio -async def test_create_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.CreateReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - )) - response = await client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.CreateReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -@pytest.mark.asyncio -async def test_create_reservation_async_from_dict(): - await test_create_reservation_async(request_type=dict) - - -def test_create_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = gcbr_reservation.CreateReservationRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.create_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = gcbr_reservation.CreateReservationRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - await client.create_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_reservation( - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') - assert args[0].reservation_id == 'reservation_id_value' - - -def test_create_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.CreateReservationRequest(), - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_reservation( - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') - assert args[0].reservation_id == 'reservation_id_value' - - -@pytest.mark.asyncio -async def test_create_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_reservation( - gcbr_reservation.CreateReservationRequest(), - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - -def test_list_reservations(transport: str = 'grpc', request_type=reservation.ListReservationsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListReservationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_reservations_from_dict(): - test_list_reservations(request_type=dict) - - -def test_list_reservations_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 = ReservationServiceClient( - 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_reservations), - '__call__') as call: - client.list_reservations() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListReservationsRequest() - - -@pytest.mark.asyncio -async def test_list_reservations_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListReservationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_reservations_async_from_dict(): - await test_list_reservations_async(request_type=dict) - - -def test_list_reservations_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListReservationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value = reservation.ListReservationsResponse() - client.list_reservations(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_reservations_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListReservationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) - await client.list_reservations(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_reservations_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_reservations( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_reservations_flattened_error(): - client = ReservationServiceClient( - 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_reservations( - reservation.ListReservationsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_reservations_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_reservations( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_reservations_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_reservations( - reservation.ListReservationsRequest(), - parent='parent_value', - ) - - -def test_list_reservations_pager(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_reservations(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, reservation.Reservation) - for i in results) - -def test_list_reservations_pages(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - pages = list(client.list_reservations(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_reservations_async_pager(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_reservations(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, reservation.Reservation) - for i in responses) - -@pytest.mark.asyncio -async def test_list_reservations_async_pages(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_reservations(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_reservation(transport: str = 'grpc', request_type=reservation.GetReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - ) - response = client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -def test_get_reservation_from_dict(): - test_get_reservation(request_type=dict) - - -def test_get_reservation_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 = ReservationServiceClient( - 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_reservation), - '__call__') as call: - client.get_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetReservationRequest() - - -@pytest.mark.asyncio -async def test_get_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - )) - response = await client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -@pytest.mark.asyncio -async def test_get_reservation_async_from_dict(): - await test_get_reservation_async(request_type=dict) - - -def test_get_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value = reservation.Reservation() - client.get_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) - await client.get_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - reservation.GetReservationRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_reservation( - reservation.GetReservationRequest(), - name='name_value', - ) - - -def test_delete_reservation(transport: str = 'grpc', request_type=reservation.DeleteReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteReservationRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_reservation_from_dict(): - test_delete_reservation(request_type=dict) - - -def test_delete_reservation_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 = ReservationServiceClient( - 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_reservation), - '__call__') as call: - client.delete_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteReservationRequest() - - -@pytest.mark.asyncio -async def test_delete_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteReservationRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_reservation_async_from_dict(): - await test_delete_reservation_async(request_type=dict) - - -def test_delete_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value = None - client.delete_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__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_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - reservation.DeleteReservationRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__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_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_reservation( - reservation.DeleteReservationRequest(), - name='name_value', - ) - - -def test_update_reservation(transport: str = 'grpc', request_type=gcbr_reservation.UpdateReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - ) - response = client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.UpdateReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -def test_update_reservation_from_dict(): - test_update_reservation(request_type=dict) - - -def test_update_reservation_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 = ReservationServiceClient( - 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_reservation), - '__call__') as call: - client.update_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.UpdateReservationRequest() - - -@pytest.mark.asyncio -async def test_update_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.UpdateReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - )) - response = await client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.UpdateReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - - -@pytest.mark.asyncio -async def test_update_reservation_async_from_dict(): - await test_update_reservation_async(request_type=dict) - - -def test_update_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = gcbr_reservation.UpdateReservationRequest() - - request.reservation.name = 'reservation.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.update_reservation(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', - 'reservation.name=reservation.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = gcbr_reservation.UpdateReservationRequest() - - request.reservation.name = 'reservation.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - await client.update_reservation(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', - 'reservation.name=reservation.name/value', - ) in kw['metadata'] - - -def test_update_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_reservation( - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_reservation( - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].reservation == gcbr_reservation.Reservation(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_create_capacity_commitment(transport: str = 'grpc', request_type=reservation.CreateCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - ) - response = client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -def test_create_capacity_commitment_from_dict(): - test_create_capacity_commitment(request_type=dict) - - -def test_create_capacity_commitment_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 = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - client.create_capacity_commitment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateCapacityCommitmentRequest() - - -@pytest.mark.asyncio -async def test_create_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - )) - response = await client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -@pytest.mark.asyncio -async def test_create_capacity_commitment_async_from_dict(): - await test_create_capacity_commitment_async(request_type=dict) - - -def test_create_capacity_commitment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.CreateCapacityCommitmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.create_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.CreateCapacityCommitmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.create_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_capacity_commitment( - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') - - -def test_create_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - -@pytest.mark.asyncio -async def test_create_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_capacity_commitment( - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') - - -@pytest.mark.asyncio -async def test_create_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - -def test_list_capacity_commitments(transport: str = 'grpc', request_type=reservation.ListCapacityCommitmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListCapacityCommitmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_capacity_commitments_from_dict(): - test_list_capacity_commitments(request_type=dict) - - -def test_list_capacity_commitments_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 = ReservationServiceClient( - 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_capacity_commitments), - '__call__') as call: - client.list_capacity_commitments() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListCapacityCommitmentsRequest() - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListCapacityCommitmentsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListCapacityCommitmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async_from_dict(): - await test_list_capacity_commitments_async(request_type=dict) - - -def test_list_capacity_commitments_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListCapacityCommitmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value = reservation.ListCapacityCommitmentsResponse() - client.list_capacity_commitments(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_capacity_commitments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListCapacityCommitmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) - await client.list_capacity_commitments(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_capacity_commitments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_capacity_commitments( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_capacity_commitments_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_capacity_commitments( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), - parent='parent_value', - ) - - -def test_list_capacity_commitments_pager(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_capacity_commitments(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, reservation.CapacityCommitment) - for i in results) - -def test_list_capacity_commitments_pages(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - pages = list(client.list_capacity_commitments(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_capacity_commitments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_capacity_commitments(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, reservation.CapacityCommitment) - for i in responses) - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_capacity_commitments(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_capacity_commitment(transport: str = 'grpc', request_type=reservation.GetCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - ) - response = client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -def test_get_capacity_commitment_from_dict(): - test_get_capacity_commitment(request_type=dict) - - -def test_get_capacity_commitment_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 = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - client.get_capacity_commitment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetCapacityCommitmentRequest() - - -@pytest.mark.asyncio -async def test_get_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.GetCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - )) - response = await client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -@pytest.mark.asyncio -async def test_get_capacity_commitment_async_from_dict(): - await test_get_capacity_commitment_async(request_type=dict) - - -def test_get_capacity_commitment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.get_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.get_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_capacity_commitment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_capacity_commitment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name='name_value', - ) - - -def test_delete_capacity_commitment(transport: str = 'grpc', request_type=reservation.DeleteCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_capacity_commitment_from_dict(): - test_delete_capacity_commitment(request_type=dict) - - -def test_delete_capacity_commitment_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 = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - client.delete_capacity_commitment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteCapacityCommitmentRequest() - - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_async_from_dict(): - await test_delete_capacity_commitment_async(request_type=dict) - - -def test_delete_capacity_commitment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value = None - client.delete_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__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_capacity_commitment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__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_capacity_commitment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name='name_value', - ) - - -def test_update_capacity_commitment(transport: str = 'grpc', request_type=reservation.UpdateCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - ) - response = client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -def test_update_capacity_commitment_from_dict(): - test_update_capacity_commitment(request_type=dict) - - -def test_update_capacity_commitment_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 = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - client.update_capacity_commitment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateCapacityCommitmentRequest() - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - )) - response = await client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_async_from_dict(): - await test_update_capacity_commitment_async(request_type=dict) - - -def test_update_capacity_commitment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.UpdateCapacityCommitmentRequest() - - request.capacity_commitment.name = 'capacity_commitment.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.update_capacity_commitment(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', - 'capacity_commitment.name=capacity_commitment.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.UpdateCapacityCommitmentRequest() - - request.capacity_commitment.name = 'capacity_commitment.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.update_capacity_commitment(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', - 'capacity_commitment.name=capacity_commitment.name/value', - ) in kw['metadata'] - - -def test_update_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_capacity_commitment( - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_capacity_commitment( - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].capacity_commitment == reservation.CapacityCommitment(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_split_capacity_commitment(transport: str = 'grpc', request_type=reservation.SplitCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse( - ) - response = client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SplitCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) - - -def test_split_capacity_commitment_from_dict(): - test_split_capacity_commitment(request_type=dict) - - -def test_split_capacity_commitment_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 = ReservationServiceClient( - 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.split_capacity_commitment), - '__call__') as call: - client.split_capacity_commitment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SplitCapacityCommitmentRequest() - - -@pytest.mark.asyncio -async def test_split_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.SplitCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( - )) - response = await client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SplitCapacityCommitmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) - - -@pytest.mark.asyncio -async def test_split_capacity_commitment_async_from_dict(): - await test_split_capacity_commitment_async(request_type=dict) - - -def test_split_capacity_commitment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SplitCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value = reservation.SplitCapacityCommitmentResponse() - client.split_capacity_commitment(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_split_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SplitCapacityCommitmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) - await client.split_capacity_commitment(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_split_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.split_capacity_commitment( - name='name_value', - slot_count=1098, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].slot_count == 1098 - - -def test_split_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), - name='name_value', - slot_count=1098, - ) - - -@pytest.mark.asyncio -async def test_split_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.split_capacity_commitment( - name='name_value', - slot_count=1098, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].slot_count == 1098 - - -@pytest.mark.asyncio -async def test_split_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), - name='name_value', - slot_count=1098, - ) - - -def test_merge_capacity_commitments(transport: str = 'grpc', request_type=reservation.MergeCapacityCommitmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - ) - response = client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MergeCapacityCommitmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -def test_merge_capacity_commitments_from_dict(): - test_merge_capacity_commitments(request_type=dict) - - -def test_merge_capacity_commitments_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 = ReservationServiceClient( - 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.merge_capacity_commitments), - '__call__') as call: - client.merge_capacity_commitments() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MergeCapacityCommitmentsRequest() - - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.MergeCapacityCommitmentsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - )) - response = await client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MergeCapacityCommitmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_async_from_dict(): - await test_merge_capacity_commitments_async(request_type=dict) - - -def test_merge_capacity_commitments_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.MergeCapacityCommitmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.merge_capacity_commitments(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_merge_capacity_commitments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.MergeCapacityCommitmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.merge_capacity_commitments(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_merge_capacity_commitments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.merge_capacity_commitments( - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].capacity_commitment_ids == ['capacity_commitment_ids_value'] - - -def test_merge_capacity_commitments_flattened_error(): - client = ReservationServiceClient( - 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.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.merge_capacity_commitments( - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].capacity_commitment_ids == ['capacity_commitment_ids_value'] - - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - -def test_create_assignment(transport: str = 'grpc', request_type=reservation.CreateAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - ) - response = client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateAssignmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - - -def test_create_assignment_from_dict(): - test_create_assignment(request_type=dict) - - -def test_create_assignment_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 = ReservationServiceClient( - 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_assignment), - '__call__') as call: - client.create_assignment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateAssignmentRequest() - - -@pytest.mark.asyncio -async def test_create_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - )) - response = await client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateAssignmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - - -@pytest.mark.asyncio -async def test_create_assignment_async_from_dict(): - await test_create_assignment_async(request_type=dict) - - -def test_create_assignment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.CreateAssignmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.create_assignment(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_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.CreateAssignmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - await client.create_assignment(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_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_assignment( - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].assignment == reservation.Assignment(name='name_value') - - -def test_create_assignment_flattened_error(): - client = ReservationServiceClient( - 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_assignment( - reservation.CreateAssignmentRequest(), - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - -@pytest.mark.asyncio -async def test_create_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_assignment( - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].assignment == reservation.Assignment(name='name_value') - - -@pytest.mark.asyncio -async def test_create_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_assignment( - reservation.CreateAssignmentRequest(), - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - -def test_list_assignments(transport: str = 'grpc', request_type=reservation.ListAssignmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_assignments_from_dict(): - test_list_assignments(request_type=dict) - - -def test_list_assignments_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 = ReservationServiceClient( - 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_assignments), - '__call__') as call: - client.list_assignments() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListAssignmentsRequest() - - -@pytest.mark.asyncio -async def test_list_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_assignments_async_from_dict(): - await test_list_assignments_async(request_type=dict) - - -def test_list_assignments_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value = reservation.ListAssignmentsResponse() - client.list_assignments(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_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.ListAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) - await client.list_assignments(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_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_assignments( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_assignments_flattened_error(): - client = ReservationServiceClient( - 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_assignments( - reservation.ListAssignmentsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_assignments( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_assignments( - reservation.ListAssignmentsRequest(), - parent='parent_value', - ) - - -def test_list_assignments_pager(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_assignments(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - -def test_list_assignments_pages(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.list_assignments(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_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_assignments(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in responses) - -@pytest.mark.asyncio -async def test_list_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_assignments(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_delete_assignment(transport: str = 'grpc', request_type=reservation.DeleteAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteAssignmentRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_assignment_from_dict(): - test_delete_assignment(request_type=dict) - - -def test_delete_assignment_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 = ReservationServiceClient( - 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_assignment), - '__call__') as call: - client.delete_assignment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteAssignmentRequest() - - -@pytest.mark.asyncio -async def test_delete_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteAssignmentRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_assignment_async_from_dict(): - await test_delete_assignment_async(request_type=dict) - - -def test_delete_assignment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteAssignmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value = None - client.delete_assignment(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_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.DeleteAssignmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_assignment(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_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__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_assignment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_assignment_flattened_error(): - client = ReservationServiceClient( - 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_assignment( - reservation.DeleteAssignmentRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__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_assignment( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_assignment( - reservation.DeleteAssignmentRequest(), - name='name_value', - ) - - -def test_search_assignments(transport: str = 'grpc', request_type=reservation.SearchAssignmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_search_assignments_from_dict(): - test_search_assignments(request_type=dict) - - -def test_search_assignments_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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - client.search_assignments() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAssignmentsRequest() - - -@pytest.mark.asyncio -async def test_search_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_search_assignments_async_from_dict(): - await test_search_assignments_async(request_type=dict) - - -def test_search_assignments_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SearchAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value = reservation.SearchAssignmentsResponse() - client.search_assignments(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_search_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SearchAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) - await client.search_assignments(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_search_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_assignments( - parent='parent_value', - query='query_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].query == 'query_value' - - -def test_search_assignments_flattened_error(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.search_assignments( - reservation.SearchAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -@pytest.mark.asyncio -async def test_search_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_assignments( - parent='parent_value', - query='query_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].query == 'query_value' - - -@pytest.mark.asyncio -async def test_search_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_assignments( - reservation.SearchAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_assignments_pager(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.search_assignments(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - -def test_search_assignments_pages(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.search_assignments(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_search_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.search_assignments(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in responses) - -@pytest.mark.asyncio -async def test_search_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.search_assignments(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_search_all_assignments(transport: str = 'grpc', request_type=reservation.SearchAllAssignmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAllAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_search_all_assignments_from_dict(): - test_search_all_assignments(request_type=dict) - - -def test_search_all_assignments_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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - client.search_all_assignments() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAllAssignmentsRequest() - - -@pytest.mark.asyncio -async def test_search_all_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAllAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAllAssignmentsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_search_all_assignments_async_from_dict(): - await test_search_all_assignments_async(request_type=dict) - - -def test_search_all_assignments_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SearchAllAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value = reservation.SearchAllAssignmentsResponse() - client.search_all_assignments(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_search_all_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.SearchAllAssignmentsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) - await client.search_all_assignments(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_search_all_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_all_assignments( - parent='parent_value', - query='query_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].query == 'query_value' - - -def test_search_all_assignments_flattened_error(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -@pytest.mark.asyncio -async def test_search_all_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_all_assignments( - parent='parent_value', - query='query_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].query == 'query_value' - - -@pytest.mark.asyncio -async def test_search_all_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_all_assignments_pager(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.search_all_assignments(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - -def test_search_all_assignments_pages(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.search_all_assignments(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_search_all_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.search_all_assignments(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in responses) - -@pytest.mark.asyncio -async def test_search_all_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.search_all_assignments(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_move_assignment(transport: str = 'grpc', request_type=reservation.MoveAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - ) - response = client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MoveAssignmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - - -def test_move_assignment_from_dict(): - test_move_assignment(request_type=dict) - - -def test_move_assignment_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 = ReservationServiceClient( - 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.move_assignment), - '__call__') as call: - client.move_assignment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MoveAssignmentRequest() - - -@pytest.mark.asyncio -async def test_move_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.MoveAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - )) - response = await client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MoveAssignmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - - -@pytest.mark.asyncio -async def test_move_assignment_async_from_dict(): - await test_move_assignment_async(request_type=dict) - - -def test_move_assignment_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.MoveAssignmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.move_assignment(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_move_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.MoveAssignmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - await client.move_assignment(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_move_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.move_assignment( - name='name_value', - destination_id='destination_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].destination_id == 'destination_id_value' - - -def test_move_assignment_flattened_error(): - client = ReservationServiceClient( - 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.move_assignment( - reservation.MoveAssignmentRequest(), - name='name_value', - destination_id='destination_id_value', - ) - - -@pytest.mark.asyncio -async def test_move_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.move_assignment( - name='name_value', - destination_id='destination_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].destination_id == 'destination_id_value' - - -@pytest.mark.asyncio -async def test_move_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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.move_assignment( - reservation.MoveAssignmentRequest(), - name='name_value', - destination_id='destination_id_value', - ) - - -def test_get_bi_reservation(transport: str = 'grpc', request_type=reservation.GetBiReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation( - name='name_value', - size=443, - ) - response = client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetBiReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -def test_get_bi_reservation_from_dict(): - test_get_bi_reservation(request_type=dict) - - -def test_get_bi_reservation_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 = ReservationServiceClient( - 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_bi_reservation), - '__call__') as call: - client.get_bi_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetBiReservationRequest() - - -@pytest.mark.asyncio -async def test_get_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetBiReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - response = await client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetBiReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.asyncio -async def test_get_bi_reservation_async_from_dict(): - await test_get_bi_reservation_async(request_type=dict) - - -def test_get_bi_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetBiReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.get_bi_reservation(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_bi_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.GetBiReservationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - await client.get_bi_reservation(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_bi_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_bi_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_bi_reservation_flattened_error(): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.GetBiReservationRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_bi_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_bi_reservation( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_bi_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_bi_reservation( - reservation.GetBiReservationRequest(), - name='name_value', - ) - - -def test_update_bi_reservation(transport: str = 'grpc', request_type=reservation.UpdateBiReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation( - name='name_value', - size=443, - ) - response = client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateBiReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -def test_update_bi_reservation_from_dict(): - test_update_bi_reservation(request_type=dict) - - -def test_update_bi_reservation_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 = ReservationServiceClient( - 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_bi_reservation), - '__call__') as call: - client.update_bi_reservation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateBiReservationRequest() - - -@pytest.mark.asyncio -async def test_update_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateBiReservationRequest): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - response = await client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateBiReservationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.asyncio -async def test_update_bi_reservation_async_from_dict(): - await test_update_bi_reservation_async(request_type=dict) - - -def test_update_bi_reservation_field_headers(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.UpdateBiReservationRequest() - - request.bi_reservation.name = 'bi_reservation.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.update_bi_reservation(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', - 'bi_reservation.name=bi_reservation.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_bi_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = reservation.UpdateBiReservationRequest() - - request.bi_reservation.name = 'bi_reservation.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - await client.update_bi_reservation(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', - 'bi_reservation.name=bi_reservation.name/value', - ) in kw['metadata'] - - -def test_update_bi_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_bi_reservation( - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].bi_reservation == reservation.BiReservation(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_bi_reservation_flattened_error(): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_bi_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_bi_reservation( - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].bi_reservation == reservation.BiReservation(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_bi_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - 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_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = ReservationServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.ReservationServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ReservationServiceGrpcTransport, - ) - -def test_reservation_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ReservationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_reservation_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.ReservationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_reservation', - 'list_reservations', - 'get_reservation', - 'delete_reservation', - 'update_reservation', - 'create_capacity_commitment', - 'list_capacity_commitments', - 'get_capacity_commitment', - 'delete_capacity_commitment', - 'update_capacity_commitment', - 'split_capacity_commitment', - 'merge_capacity_commitments', - 'create_assignment', - 'list_assignments', - 'delete_assignment', - 'search_assignments', - 'search_all_assignments', - 'move_assignment', - 'get_bi_reservation', - 'update_bi_reservation', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - -@requires_google_auth_gte_1_25_0 -def test_reservation_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ReservationServiceTransport( - 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/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_reservation_service_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ReservationServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_reservation_service_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ReservationServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_reservation_service_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - ReservationServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_reservation_service_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - ReservationServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_reservation_service_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_reservation_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.ReservationServiceGrpcTransport, grpc_helpers), - (transports.ReservationServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_reservation_service_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "bigqueryreservation.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="bigqueryreservation.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_reservation_service_host_no_port(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com'), - ) - assert client.transport._host == 'bigqueryreservation.googleapis.com:443' - - -def test_reservation_service_host_with_port(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com:8000'), - ) - assert client.transport._host == 'bigqueryreservation.googleapis.com:8000' - -def test_reservation_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ReservationServiceGrpcTransport( - 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_reservation_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ReservationServiceGrpcAsyncIOTransport( - 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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_assignment_path(): - project = "squid" - location = "clam" - reservation = "whelk" - assignment = "octopus" - expected = "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) - actual = ReservationServiceClient.assignment_path(project, location, reservation, assignment) - assert expected == actual - - -def test_parse_assignment_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - "reservation": "cuttlefish", - "assignment": "mussel", - } - path = ReservationServiceClient.assignment_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_assignment_path(path) - assert expected == actual - -def test_bi_reservation_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) - actual = ReservationServiceClient.bi_reservation_path(project, location) - assert expected == actual - - -def test_parse_bi_reservation_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = ReservationServiceClient.bi_reservation_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_bi_reservation_path(path) - assert expected == actual - -def test_capacity_commitment_path(): - project = "squid" - location = "clam" - capacity_commitment = "whelk" - expected = "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) - actual = ReservationServiceClient.capacity_commitment_path(project, location, capacity_commitment) - assert expected == actual - - -def test_parse_capacity_commitment_path(): - expected = { - "project": "octopus", - "location": "oyster", - "capacity_commitment": "nudibranch", - } - path = ReservationServiceClient.capacity_commitment_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_capacity_commitment_path(path) - assert expected == actual - -def test_reservation_path(): - project = "cuttlefish" - location = "mussel" - reservation = "winkle" - expected = "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) - actual = ReservationServiceClient.reservation_path(project, location, reservation) - assert expected == actual - - -def test_parse_reservation_path(): - expected = { - "project": "nautilus", - "location": "scallop", - "reservation": "abalone", - } - path = ReservationServiceClient.reservation_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_reservation_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = ReservationServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = ReservationServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = ReservationServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = ReservationServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = ReservationServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = ReservationServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = ReservationServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = ReservationServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.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 = ReservationServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = ReservationServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = ReservationServiceClient.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 = ReservationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - -def test_transport_close(): - transports = { - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'grpc', - ] - for transport in transports: - client = ReservationServiceClient( - 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() diff --git a/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py index 413e9eb5..0646fd10 100644 --- a/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py +++ b/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py @@ -29,6 +29,7 @@ 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.bigquery_reservation_v1.services.reservation_service import ( @@ -6122,6 +6123,9 @@ def test_reservation_service_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + @requires_google_auth_gte_1_25_0 def test_reservation_service_base_transport_with_credentials_file(): @@ -6706,3 +6710,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): 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 = ReservationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = ReservationServiceClient( + 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()