From f0ab07c14bf8ce14ebbab11f038dbc122d406898 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 6 Oct 2021 22:59:35 +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 + owl-bot-staging/v1/docs/conf.py | 376 ++ owl-bot-staging/v1/docs/index.rst | 7 + .../secret_manager_service.rst | 10 + .../v1/docs/secretmanager_v1/services.rst | 6 + .../v1/docs/secretmanager_v1/types.rst | 7 + .../v1/google/cloud/secretmanager/__init__.py | 71 + .../v1/google/cloud/secretmanager/py.typed | 2 + .../google/cloud/secretmanager_v1/__init__.py | 72 + .../secretmanager_v1/gapic_metadata.json | 173 + .../v1/google/cloud/secretmanager_v1/py.typed | 2 + .../secretmanager_v1/services/__init__.py | 15 + .../secret_manager_service/__init__.py | 22 + .../secret_manager_service/async_client.py | 1526 ++++++ .../services/secret_manager_service/client.py | 1731 ++++++ .../services/secret_manager_service/pagers.py | 263 + .../transports/__init__.py | 33 + .../secret_manager_service/transports/base.py | 384 ++ .../secret_manager_service/transports/grpc.py | 685 +++ .../transports/grpc_asyncio.py | 690 +++ .../cloud/secretmanager_v1/types/__init__.py | 70 + .../cloud/secretmanager_v1/types/resources.py | 558 ++ .../cloud/secretmanager_v1/types/service.py | 488 ++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../fixup_secretmanager_v1_keywords.py | 190 + 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 + .../unit/gapic/secretmanager_v1/__init__.py | 16 + .../test_secret_manager_service.py | 4780 +++++++++++++++++ 34 files changed, 12482 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/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst create mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py create mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_secretmanager_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/secretmanager_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..2287362 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/secretmanager/__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 0000000..3f781d4 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/secretmanager *.py +recursive-include google/cloud/secretmanager_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..358776d --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Secretmanager 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 Secretmanager API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..3d2ecfc --- /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-secretmanager 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-secretmanager" +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-secretmanager-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-secretmanager.tex", + u"google-cloud-secretmanager 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-secretmanager", + u"Google Cloud Secretmanager 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-secretmanager", + u"google-cloud-secretmanager Documentation", + author, + "google-cloud-secretmanager", + "GAPIC library for Google Cloud Secretmanager API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..9072a8c --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + secretmanager_v1/services + secretmanager_v1/types diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst b/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst new file mode 100644 index 0000000..2aa590e --- /dev/null +++ b/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst @@ -0,0 +1,10 @@ +SecretManagerService +-------------------------------------- + +.. automodule:: google.cloud.secretmanager_v1.services.secret_manager_service + :members: + :inherited-members: + +.. automodule:: google.cloud.secretmanager_v1.services.secret_manager_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/services.rst b/owl-bot-staging/v1/docs/secretmanager_v1/services.rst new file mode 100644 index 0000000..aac8f75 --- /dev/null +++ b/owl-bot-staging/v1/docs/secretmanager_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Secretmanager v1 API +============================================== +.. toctree:: + :maxdepth: 2 + + secret_manager_service diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/types.rst b/owl-bot-staging/v1/docs/secretmanager_v1/types.rst new file mode 100644 index 0000000..a3cb4ce --- /dev/null +++ b/owl-bot-staging/v1/docs/secretmanager_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Secretmanager v1 API +=========================================== + +.. automodule:: google.cloud.secretmanager_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py new file mode 100644 index 0000000..5e40a78 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.secretmanager_v1.services.secret_manager_service.client import SecretManagerServiceClient +from google.cloud.secretmanager_v1.services.secret_manager_service.async_client import SecretManagerServiceAsyncClient + +from google.cloud.secretmanager_v1.types.resources import CustomerManagedEncryption +from google.cloud.secretmanager_v1.types.resources import CustomerManagedEncryptionStatus +from google.cloud.secretmanager_v1.types.resources import Replication +from google.cloud.secretmanager_v1.types.resources import ReplicationStatus +from google.cloud.secretmanager_v1.types.resources import Rotation +from google.cloud.secretmanager_v1.types.resources import Secret +from google.cloud.secretmanager_v1.types.resources import SecretPayload +from google.cloud.secretmanager_v1.types.resources import SecretVersion +from google.cloud.secretmanager_v1.types.resources import Topic +from google.cloud.secretmanager_v1.types.service import AccessSecretVersionRequest +from google.cloud.secretmanager_v1.types.service import AccessSecretVersionResponse +from google.cloud.secretmanager_v1.types.service import AddSecretVersionRequest +from google.cloud.secretmanager_v1.types.service import CreateSecretRequest +from google.cloud.secretmanager_v1.types.service import DeleteSecretRequest +from google.cloud.secretmanager_v1.types.service import DestroySecretVersionRequest +from google.cloud.secretmanager_v1.types.service import DisableSecretVersionRequest +from google.cloud.secretmanager_v1.types.service import EnableSecretVersionRequest +from google.cloud.secretmanager_v1.types.service import GetSecretRequest +from google.cloud.secretmanager_v1.types.service import GetSecretVersionRequest +from google.cloud.secretmanager_v1.types.service import ListSecretsRequest +from google.cloud.secretmanager_v1.types.service import ListSecretsResponse +from google.cloud.secretmanager_v1.types.service import ListSecretVersionsRequest +from google.cloud.secretmanager_v1.types.service import ListSecretVersionsResponse +from google.cloud.secretmanager_v1.types.service import UpdateSecretRequest + +__all__ = ('SecretManagerServiceClient', + 'SecretManagerServiceAsyncClient', + 'CustomerManagedEncryption', + 'CustomerManagedEncryptionStatus', + 'Replication', + 'ReplicationStatus', + 'Rotation', + 'Secret', + 'SecretPayload', + 'SecretVersion', + 'Topic', + 'AccessSecretVersionRequest', + 'AccessSecretVersionResponse', + 'AddSecretVersionRequest', + 'CreateSecretRequest', + 'DeleteSecretRequest', + 'DestroySecretVersionRequest', + 'DisableSecretVersionRequest', + 'EnableSecretVersionRequest', + 'GetSecretRequest', + 'GetSecretVersionRequest', + 'ListSecretsRequest', + 'ListSecretsResponse', + 'ListSecretVersionsRequest', + 'ListSecretVersionsResponse', + 'UpdateSecretRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager/py.typed b/owl-bot-staging/v1/google/cloud/secretmanager/py.typed new file mode 100644 index 0000000..188cc03 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-secretmanager package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py new file mode 100644 index 0000000..102f4d0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.secret_manager_service import SecretManagerServiceClient +from .services.secret_manager_service import SecretManagerServiceAsyncClient + +from .types.resources import CustomerManagedEncryption +from .types.resources import CustomerManagedEncryptionStatus +from .types.resources import Replication +from .types.resources import ReplicationStatus +from .types.resources import Rotation +from .types.resources import Secret +from .types.resources import SecretPayload +from .types.resources import SecretVersion +from .types.resources import Topic +from .types.service import AccessSecretVersionRequest +from .types.service import AccessSecretVersionResponse +from .types.service import AddSecretVersionRequest +from .types.service import CreateSecretRequest +from .types.service import DeleteSecretRequest +from .types.service import DestroySecretVersionRequest +from .types.service import DisableSecretVersionRequest +from .types.service import EnableSecretVersionRequest +from .types.service import GetSecretRequest +from .types.service import GetSecretVersionRequest +from .types.service import ListSecretsRequest +from .types.service import ListSecretsResponse +from .types.service import ListSecretVersionsRequest +from .types.service import ListSecretVersionsResponse +from .types.service import UpdateSecretRequest + +__all__ = ( + 'SecretManagerServiceAsyncClient', +'AccessSecretVersionRequest', +'AccessSecretVersionResponse', +'AddSecretVersionRequest', +'CreateSecretRequest', +'CustomerManagedEncryption', +'CustomerManagedEncryptionStatus', +'DeleteSecretRequest', +'DestroySecretVersionRequest', +'DisableSecretVersionRequest', +'EnableSecretVersionRequest', +'GetSecretRequest', +'GetSecretVersionRequest', +'ListSecretVersionsRequest', +'ListSecretVersionsResponse', +'ListSecretsRequest', +'ListSecretsResponse', +'Replication', +'ReplicationStatus', +'Rotation', +'Secret', +'SecretManagerServiceClient', +'SecretPayload', +'SecretVersion', +'Topic', +'UpdateSecretRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json new file mode 100644 index 0000000..4c427b1 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json @@ -0,0 +1,173 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.secretmanager_v1", + "protoPackage": "google.cloud.secretmanager.v1", + "schema": "1.0", + "services": { + "SecretManagerService": { + "clients": { + "grpc": { + "libraryClient": "SecretManagerServiceClient", + "rpcs": { + "AccessSecretVersion": { + "methods": [ + "access_secret_version" + ] + }, + "AddSecretVersion": { + "methods": [ + "add_secret_version" + ] + }, + "CreateSecret": { + "methods": [ + "create_secret" + ] + }, + "DeleteSecret": { + "methods": [ + "delete_secret" + ] + }, + "DestroySecretVersion": { + "methods": [ + "destroy_secret_version" + ] + }, + "DisableSecretVersion": { + "methods": [ + "disable_secret_version" + ] + }, + "EnableSecretVersion": { + "methods": [ + "enable_secret_version" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetSecret": { + "methods": [ + "get_secret" + ] + }, + "GetSecretVersion": { + "methods": [ + "get_secret_version" + ] + }, + "ListSecretVersions": { + "methods": [ + "list_secret_versions" + ] + }, + "ListSecrets": { + "methods": [ + "list_secrets" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateSecret": { + "methods": [ + "update_secret" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SecretManagerServiceAsyncClient", + "rpcs": { + "AccessSecretVersion": { + "methods": [ + "access_secret_version" + ] + }, + "AddSecretVersion": { + "methods": [ + "add_secret_version" + ] + }, + "CreateSecret": { + "methods": [ + "create_secret" + ] + }, + "DeleteSecret": { + "methods": [ + "delete_secret" + ] + }, + "DestroySecretVersion": { + "methods": [ + "destroy_secret_version" + ] + }, + "DisableSecretVersion": { + "methods": [ + "disable_secret_version" + ] + }, + "EnableSecretVersion": { + "methods": [ + "enable_secret_version" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetSecret": { + "methods": [ + "get_secret" + ] + }, + "GetSecretVersion": { + "methods": [ + "get_secret_version" + ] + }, + "ListSecretVersions": { + "methods": [ + "list_secret_versions" + ] + }, + "ListSecrets": { + "methods": [ + "list_secrets" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateSecret": { + "methods": [ + "update_secret" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed b/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed new file mode 100644 index 0000000..188cc03 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-secretmanager package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_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/secretmanager_v1/services/secret_manager_service/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/__init__.py new file mode 100644 index 0000000..8dc1ffe --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_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 SecretManagerServiceClient +from .async_client import SecretManagerServiceAsyncClient + +__all__ = ( + 'SecretManagerServiceClient', + 'SecretManagerServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py new file mode 100644 index 0000000..03d588b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py @@ -0,0 +1,1526 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.secretmanager_v1.services.secret_manager_service import pagers +from google.cloud.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport +from .client import SecretManagerServiceClient + + +class SecretManagerServiceAsyncClient: + """Secret Manager Service + + Manages secrets and operations using those secrets. Implements a + REST model with the following objects: + + - [Secret][google.cloud.secretmanager.v1.Secret] + - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + """ + + _client: SecretManagerServiceClient + + DEFAULT_ENDPOINT = SecretManagerServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SecretManagerServiceClient.DEFAULT_MTLS_ENDPOINT + + secret_path = staticmethod(SecretManagerServiceClient.secret_path) + parse_secret_path = staticmethod(SecretManagerServiceClient.parse_secret_path) + secret_version_path = staticmethod(SecretManagerServiceClient.secret_version_path) + parse_secret_version_path = staticmethod(SecretManagerServiceClient.parse_secret_version_path) + topic_path = staticmethod(SecretManagerServiceClient.topic_path) + parse_topic_path = staticmethod(SecretManagerServiceClient.parse_topic_path) + common_billing_account_path = staticmethod(SecretManagerServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SecretManagerServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SecretManagerServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(SecretManagerServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(SecretManagerServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(SecretManagerServiceClient.parse_common_organization_path) + common_project_path = staticmethod(SecretManagerServiceClient.common_project_path) + parse_common_project_path = staticmethod(SecretManagerServiceClient.parse_common_project_path) + common_location_path = staticmethod(SecretManagerServiceClient.common_location_path) + parse_common_location_path = staticmethod(SecretManagerServiceClient.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: + SecretManagerServiceAsyncClient: The constructed client. + """ + return SecretManagerServiceClient.from_service_account_info.__func__(SecretManagerServiceAsyncClient, 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: + SecretManagerServiceAsyncClient: The constructed client. + """ + return SecretManagerServiceClient.from_service_account_file.__func__(SecretManagerServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> SecretManagerServiceTransport: + """Returns the transport used by the client instance. + + Returns: + SecretManagerServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SecretManagerServiceClient).get_transport_class, type(SecretManagerServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, SecretManagerServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the secret manager 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, ~.SecretManagerServiceTransport]): 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 = SecretManagerServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_secrets(self, + request: service.ListSecretsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSecretsAsyncPager: + r"""Lists [Secrets][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.ListSecretsRequest`): + The request object. Request message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + parent (:class:`str`): + Required. The resource name of the project associated + with the + [Secrets][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*``. + + 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretsAsyncPager: + Response message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + + 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 = service.ListSecretsRequest(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_secrets, + 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.ListSecretsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_secret(self, + request: service.CreateSecretRequest = None, + *, + parent: str = None, + secret_id: str = None, + secret: resources.Secret = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Creates a new [Secret][google.cloud.secretmanager.v1.Secret] + containing no + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.CreateSecretRequest`): + The request object. Request message for + [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. + parent (:class:`str`): + Required. The resource name of the project to associate + with the [Secret][google.cloud.secretmanager.v1.Secret], + in the format ``projects/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + secret_id (:class:`str`): + Required. This must be unique within the project. + + A secret ID is a string with a maximum length of 255 + characters and can contain uppercase and lowercase + letters, numerals, and the hyphen (``-``) and underscore + (``_``) characters. + + This corresponds to the ``secret_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + secret (:class:`google.cloud.secretmanager_v1.types.Secret`): + Required. A + [Secret][google.cloud.secretmanager.v1.Secret] with + initial field values. + + This corresponds to the ``secret`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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, secret_id, secret]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.CreateSecretRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if secret_id is not None: + request.secret_id = secret_id + if secret is not None: + request.secret = secret + + # 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_secret, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def add_secret_version(self, + request: service.AddSecretVersionRequest = None, + *, + parent: str = None, + payload: resources.SecretPayload = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Creates a new + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + containing secret data and attaches it to an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.AddSecretVersionRequest`): + The request object. Request message for + [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. + parent (:class:`str`): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to + associate with the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + payload (:class:`google.cloud.secretmanager_v1.types.SecretPayload`): + Required. The secret payload of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + This corresponds to the ``payload`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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, payload]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.AddSecretVersionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if payload is not None: + request.payload = payload + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.add_secret_version, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_secret(self, + request: service.GetSecretRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Gets metadata for a given + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.GetSecretRequest`): + The request object. Request message for + [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. + name (:class:`str`): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*/secrets/*``. + + 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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 = service.GetSecretRequest(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_secret, + 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_secret(self, + request: service.UpdateSecretRequest = None, + *, + secret: resources.Secret = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Updates metadata of an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.UpdateSecretRequest`): + The request object. Request message for + [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. + secret (:class:`google.cloud.secretmanager_v1.types.Secret`): + Required. [Secret][google.cloud.secretmanager.v1.Secret] + with updated field values. + + This corresponds to the ``secret`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. Specifies the 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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([secret, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.UpdateSecretRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if secret is not None: + request.secret = secret + 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_secret, + 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(( + ("secret.name", request.secret.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_secret(self, + request: service.DeleteSecretRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.DeleteSecretRequest`): + The request object. Request message for + [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. + name (:class:`str`): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to delete + in the format ``projects/*/secrets/*``. + + 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 = service.DeleteSecretRequest(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_secret, + 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 list_secret_versions(self, + request: service.ListSecretVersionsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSecretVersionsAsyncPager: + r"""Lists + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + This call does not return secret data. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.ListSecretVersionsRequest`): + The request object. Request message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + parent (:class:`str`): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] + associated with the + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + to list, in the format ``projects/*/secrets/*``. + + 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager: + Response message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + + 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 = service.ListSecretVersionsRequest(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_secret_versions, + 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.ListSecretVersionsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_secret_version(self, + request: service.GetSecretVersionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Gets metadata for a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.GetSecretVersionRequest`): + The request object. Request message for + [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. + name (:class:`str`): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to + the most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 = service.GetSecretVersionRequest(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_secret_version, + 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 access_secret_version(self, + request: service.AccessSecretVersionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.AccessSecretVersionResponse: + r"""Accesses a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.AccessSecretVersionRequest`): + The request object. Request message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + name (:class:`str`): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to + the most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + 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.secretmanager_v1.types.AccessSecretVersionResponse: + Response message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + + """ + # 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 = service.AccessSecretVersionRequest(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.access_secret_version, + default_retry=retries.Retry( +initial=2.0,maximum=60.0,multiplier=2.0, predicate=retries.if_exception_type( + core_exceptions.ResourceExhausted, + 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 disable_secret_version(self, + request: service.DisableSecretVersionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Disables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.DisableSecretVersionRequest`): + The request object. Request message for + [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. + name (:class:`str`): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to disable in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 = service.DisableSecretVersionRequest(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.disable_secret_version, + 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 enable_secret_version(self, + request: service.EnableSecretVersionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Enables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.EnableSecretVersionRequest`): + The request object. Request message for + [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. + name (:class:`str`): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to enable in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 = service.EnableSecretVersionRequest(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.enable_secret_version, + 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 destroy_secret_version(self, + request: service.DestroySecretVersionRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Destroys a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] + and irrevocably destroys the secret data. + + Args: + request (:class:`google.cloud.secretmanager_v1.types.DestroySecretVersionRequest`): + The request object. Request message for + [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. + name (:class:`str`): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to destroy in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 = service.DestroySecretVersionRequest(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.destroy_secret_version, + 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 set_iam_policy(self, + request: iam_policy_pb2.SetIamPolicyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Sets the access control policy on the specified secret. Replaces + any existing policy. + + Permissions on + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + are enforced according to the policy set on the associated + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.SetIamPolicyRequest`): + The request object. Request message for `SetIamPolicy` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **JSON Example** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": ["user:eve@example.com"], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ] + + } + + **YAML Example** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.SetIamPolicyRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.set_iam_policy, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_iam_policy(self, + request: iam_policy_pb2.GetIamPolicyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a secret. + Returns empty policy if the secret exists and does not + have a policy set. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.GetIamPolicyRequest`): + The request object. Request message for `GetIamPolicy` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **JSON Example** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": ["user:eve@example.com"], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ] + + } + + **YAML Example** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.GetIamPolicyRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_iam_policy, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def test_iam_permissions(self, + request: iam_policy_pb2.TestIamPermissionsRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Returns permissions that a caller has for the specified secret. + If the secret does not exist, this call returns an empty set of + permissions, not a NOT_FOUND error. + + Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without + warning. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest`): + The request object. Request message for + `TestIamPermissions` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.test_iam_permissions, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + 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-secretmanager", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SecretManagerServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py new file mode 100644 index 0000000..cbee61b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py @@ -0,0 +1,1731 @@ +# -*- 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 + +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.secretmanager_v1.services.secret_manager_service import pagers +from google.cloud.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SecretManagerServiceGrpcTransport +from .transports.grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport + + +class SecretManagerServiceClientMeta(type): + """Metaclass for the SecretManagerService 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[SecretManagerServiceTransport]] + _transport_registry["grpc"] = SecretManagerServiceGrpcTransport + _transport_registry["grpc_asyncio"] = SecretManagerServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[SecretManagerServiceTransport]: + """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 SecretManagerServiceClient(metaclass=SecretManagerServiceClientMeta): + """Secret Manager Service + + Manages secrets and operations using those secrets. Implements a + REST model with the following objects: + + - [Secret][google.cloud.secretmanager.v1.Secret] + - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + """ + + @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 = "secretmanager.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: + SecretManagerServiceClient: 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: + SecretManagerServiceClient: 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) -> SecretManagerServiceTransport: + """Returns the transport used by the client instance. + + Returns: + SecretManagerServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def secret_path(project: str,secret: str,) -> str: + """Returns a fully-qualified secret string.""" + return "projects/{project}/secrets/{secret}".format(project=project, secret=secret, ) + + @staticmethod + def parse_secret_path(path: str) -> Dict[str,str]: + """Parses a secret path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/secrets/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def secret_version_path(project: str,secret: str,secret_version: str,) -> str: + """Returns a fully-qualified secret_version string.""" + return "projects/{project}/secrets/{secret}/versions/{secret_version}".format(project=project, secret=secret, secret_version=secret_version, ) + + @staticmethod + def parse_secret_version_path(path: str) -> Dict[str,str]: + """Parses a secret_version path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/secrets/(?P.+?)/versions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def topic_path(project: str,topic: str,) -> str: + """Returns a fully-qualified topic string.""" + return "projects/{project}/topics/{topic}".format(project=project, topic=topic, ) + + @staticmethod + def parse_topic_path(path: str) -> Dict[str,str]: + """Parses a topic path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/topics/(?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, SecretManagerServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the secret manager 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, SecretManagerServiceTransport]): 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, SecretManagerServiceTransport): + # transport is a SecretManagerServiceTransport 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 list_secrets(self, + request: Union[service.ListSecretsRequest, dict] = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSecretsPager: + r"""Lists [Secrets][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.ListSecretsRequest, dict]): + The request object. Request message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + parent (str): + Required. The resource name of the project associated + with the + [Secrets][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*``. + + 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretsPager: + Response message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + + 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 service.ListSecretsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.ListSecretsRequest): + request = service.ListSecretsRequest(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_secrets] + + # 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.ListSecretsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_secret(self, + request: Union[service.CreateSecretRequest, dict] = None, + *, + parent: str = None, + secret_id: str = None, + secret: resources.Secret = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Creates a new [Secret][google.cloud.secretmanager.v1.Secret] + containing no + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.CreateSecretRequest, dict]): + The request object. Request message for + [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. + parent (str): + Required. The resource name of the project to associate + with the [Secret][google.cloud.secretmanager.v1.Secret], + in the format ``projects/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + secret_id (str): + Required. This must be unique within the project. + + A secret ID is a string with a maximum length of 255 + characters and can contain uppercase and lowercase + letters, numerals, and the hyphen (``-``) and underscore + (``_``) characters. + + This corresponds to the ``secret_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + secret (google.cloud.secretmanager_v1.types.Secret): + Required. A + [Secret][google.cloud.secretmanager.v1.Secret] with + initial field values. + + This corresponds to the ``secret`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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, secret_id, secret]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.CreateSecretRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.CreateSecretRequest): + request = service.CreateSecretRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if secret_id is not None: + request.secret_id = secret_id + if secret is not None: + request.secret = secret + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_secret] + + # 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 add_secret_version(self, + request: Union[service.AddSecretVersionRequest, dict] = None, + *, + parent: str = None, + payload: resources.SecretPayload = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Creates a new + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + containing secret data and attaches it to an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.AddSecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. + parent (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to + associate with the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + payload (google.cloud.secretmanager_v1.types.SecretPayload): + Required. The secret payload of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + This corresponds to the ``payload`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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, payload]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.AddSecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.AddSecretVersionRequest): + request = service.AddSecretVersionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if payload is not None: + request.payload = payload + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.add_secret_version] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_secret(self, + request: Union[service.GetSecretRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Gets metadata for a given + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.GetSecretRequest, dict]): + The request object. Request message for + [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. + name (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*/secrets/*``. + + 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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 service.GetSecretRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.GetSecretRequest): + request = service.GetSecretRequest(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_secret] + + # 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_secret(self, + request: Union[service.UpdateSecretRequest, dict] = None, + *, + secret: resources.Secret = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Secret: + r"""Updates metadata of an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.UpdateSecretRequest, dict]): + The request object. Request message for + [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. + secret (google.cloud.secretmanager_v1.types.Secret): + Required. [Secret][google.cloud.secretmanager.v1.Secret] + with updated field values. + + This corresponds to the ``secret`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Specifies the 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.secretmanager_v1.types.Secret: + A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can + be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is + made up of zero or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + that represent the secret data. + + """ + # 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([secret, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.UpdateSecretRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.UpdateSecretRequest): + request = service.UpdateSecretRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if secret is not None: + request.secret = secret + 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_secret] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("secret.name", request.secret.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_secret(self, + request: Union[service.DeleteSecretRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.DeleteSecretRequest, dict]): + The request object. Request message for + [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. + name (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to delete + in the format ``projects/*/secrets/*``. + + 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 service.DeleteSecretRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.DeleteSecretRequest): + request = service.DeleteSecretRequest(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_secret] + + # 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 list_secret_versions(self, + request: Union[service.ListSecretVersionsRequest, dict] = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSecretVersionsPager: + r"""Lists + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + This call does not return secret data. + + Args: + request (Union[google.cloud.secretmanager_v1.types.ListSecretVersionsRequest, dict]): + The request object. Request message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + parent (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] + associated with the + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + to list, in the format ``projects/*/secrets/*``. + + 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretVersionsPager: + Response message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + + 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 service.ListSecretVersionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.ListSecretVersionsRequest): + request = service.ListSecretVersionsRequest(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_secret_versions] + + # 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.ListSecretVersionsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_secret_version(self, + request: Union[service.GetSecretVersionRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Gets metadata for a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.GetSecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to + the most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 service.GetSecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.GetSecretVersionRequest): + request = service.GetSecretVersionRequest(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_secret_version] + + # 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 access_secret_version(self, + request: Union[service.AccessSecretVersionRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.AccessSecretVersionResponse: + r"""Accesses a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.AccessSecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to + the most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + 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.secretmanager_v1.types.AccessSecretVersionResponse: + Response message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + + """ + # 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 service.AccessSecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.AccessSecretVersionRequest): + request = service.AccessSecretVersionRequest(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.access_secret_version] + + # 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 disable_secret_version(self, + request: Union[service.DisableSecretVersionRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Disables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.DisableSecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to disable in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 service.DisableSecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.DisableSecretVersionRequest): + request = service.DisableSecretVersionRequest(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.disable_secret_version] + + # 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 enable_secret_version(self, + request: Union[service.EnableSecretVersionRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Enables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. + + Args: + request (Union[google.cloud.secretmanager_v1.types.EnableSecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to enable in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 service.EnableSecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.EnableSecretVersionRequest): + request = service.EnableSecretVersionRequest(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.enable_secret_version] + + # 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 destroy_secret_version(self, + request: Union[service.DestroySecretVersionRequest, dict] = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.SecretVersion: + r"""Destroys a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] + and irrevocably destroys the secret data. + + Args: + request (Union[google.cloud.secretmanager_v1.types.DestroySecretVersionRequest, dict]): + The request object. Request message for + [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to destroy in the format + ``projects/*/secrets/*/versions/*``. + + 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.secretmanager_v1.types.SecretVersion: + A secret version resource in the + Secret Manager API. + + """ + # 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 service.DestroySecretVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.DestroySecretVersionRequest): + request = service.DestroySecretVersionRequest(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.destroy_secret_version] + + # 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 set_iam_policy(self, + request: Union[iam_policy_pb2.SetIamPolicyRequest, dict] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Sets the access control policy on the specified secret. Replaces + any existing policy. + + Permissions on + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + are enforced according to the policy set on the associated + [Secret][google.cloud.secretmanager.v1.Secret]. + + Args: + request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): + The request object. Request message for `SetIamPolicy` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **JSON Example** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": ["user:eve@example.com"], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ] + + } + + **YAML Example** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.SetIamPolicyRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_iam_policy(self, + request: Union[iam_policy_pb2.GetIamPolicyRequest, dict] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a secret. + Returns empty policy if the secret exists and does not + have a policy set. + + Args: + request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): + The request object. Request message for `GetIamPolicy` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **JSON Example** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": ["user:eve@example.com"], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ] + + } + + **YAML Example** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.GetIamPolicyRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def test_iam_permissions(self, + request: Union[iam_policy_pb2.TestIamPermissionsRequest, dict] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Returns permissions that a caller has for the specified secret. + If the secret does not exist, this call returns an empty set of + permissions, not a NOT_FOUND error. + + Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without + warning. + + Args: + request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): + The request object. Request message for + `TestIamPermissions` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions method. + """ + # Create or coerce a protobuf request object. + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.TestIamPermissionsRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + 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-secretmanager", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SecretManagerServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py new file mode 100644 index 0000000..d0266e9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py @@ -0,0 +1,263 @@ +# -*- 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.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service + + +class ListSecretsPager: + """A pager for iterating through ``list_secrets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``secrets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListSecrets`` requests and continue to iterate + through the ``secrets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., service.ListSecretsResponse], + request: service.ListSecretsRequest, + response: service.ListSecretsResponse, + *, + 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.secretmanager_v1.types.ListSecretsRequest): + The initial request object. + response (google.cloud.secretmanager_v1.types.ListSecretsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = service.ListSecretsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[service.ListSecretsResponse]: + 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[resources.Secret]: + for page in self.pages: + yield from page.secrets + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListSecretsAsyncPager: + """A pager for iterating through ``list_secrets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``secrets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListSecrets`` requests and continue to iterate + through the ``secrets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[service.ListSecretsResponse]], + request: service.ListSecretsRequest, + response: service.ListSecretsResponse, + *, + 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.secretmanager_v1.types.ListSecretsRequest): + The initial request object. + response (google.cloud.secretmanager_v1.types.ListSecretsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = service.ListSecretsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[service.ListSecretsResponse]: + 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[resources.Secret]: + async def async_generator(): + async for page in self.pages: + for response in page.secrets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListSecretVersionsPager: + """A pager for iterating through ``list_secret_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``versions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListSecretVersions`` requests and continue to iterate + through the ``versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., service.ListSecretVersionsResponse], + request: service.ListSecretVersionsRequest, + response: service.ListSecretVersionsResponse, + *, + 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.secretmanager_v1.types.ListSecretVersionsRequest): + The initial request object. + response (google.cloud.secretmanager_v1.types.ListSecretVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = service.ListSecretVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[service.ListSecretVersionsResponse]: + 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[resources.SecretVersion]: + for page in self.pages: + yield from page.versions + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListSecretVersionsAsyncPager: + """A pager for iterating through ``list_secret_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``versions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListSecretVersions`` requests and continue to iterate + through the ``versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[service.ListSecretVersionsResponse]], + request: service.ListSecretVersionsRequest, + response: service.ListSecretVersionsResponse, + *, + 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.secretmanager_v1.types.ListSecretVersionsRequest): + The initial request object. + response (google.cloud.secretmanager_v1.types.ListSecretVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = service.ListSecretVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[service.ListSecretVersionsResponse]: + 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[resources.SecretVersion]: + async def async_generator(): + async for page in self.pages: + for response in page.versions: + 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/secretmanager_v1/services/secret_manager_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/__init__.py new file mode 100644 index 0000000..1004413 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_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 SecretManagerServiceTransport +from .grpc import SecretManagerServiceGrpcTransport +from .grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SecretManagerServiceTransport]] +_transport_registry['grpc'] = SecretManagerServiceGrpcTransport +_transport_registry['grpc_asyncio'] = SecretManagerServiceGrpcAsyncIOTransport + +__all__ = ( + 'SecretManagerServiceTransport', + 'SecretManagerServiceGrpcTransport', + 'SecretManagerServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py new file mode 100644 index 0000000..e38df13 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py @@ -0,0 +1,384 @@ +# -*- 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.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +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-secretmanager', + ).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 SecretManagerServiceTransport(abc.ABC): + """Abstract transport class for SecretManagerService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'secretmanager.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.list_secrets: gapic_v1.method.wrap_method( + self.list_secrets, + default_timeout=60.0, + client_info=client_info, + ), + self.create_secret: gapic_v1.method.wrap_method( + self.create_secret, + default_timeout=60.0, + client_info=client_info, + ), + self.add_secret_version: gapic_v1.method.wrap_method( + self.add_secret_version, + default_timeout=60.0, + client_info=client_info, + ), + self.get_secret: gapic_v1.method.wrap_method( + self.get_secret, + default_timeout=60.0, + client_info=client_info, + ), + self.update_secret: gapic_v1.method.wrap_method( + self.update_secret, + default_timeout=60.0, + client_info=client_info, + ), + self.delete_secret: gapic_v1.method.wrap_method( + self.delete_secret, + default_timeout=60.0, + client_info=client_info, + ), + self.list_secret_versions: gapic_v1.method.wrap_method( + self.list_secret_versions, + default_timeout=60.0, + client_info=client_info, + ), + self.get_secret_version: gapic_v1.method.wrap_method( + self.get_secret_version, + default_timeout=60.0, + client_info=client_info, + ), + self.access_secret_version: gapic_v1.method.wrap_method( + self.access_secret_version, + default_retry=retries.Retry( +initial=2.0,maximum=60.0,multiplier=2.0, predicate=retries.if_exception_type( + core_exceptions.ResourceExhausted, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.disable_secret_version: gapic_v1.method.wrap_method( + self.disable_secret_version, + default_timeout=60.0, + client_info=client_info, + ), + self.enable_secret_version: gapic_v1.method.wrap_method( + self.enable_secret_version, + default_timeout=60.0, + client_info=client_info, + ), + self.destroy_secret_version: gapic_v1.method.wrap_method( + self.destroy_secret_version, + default_timeout=60.0, + client_info=client_info, + ), + self.set_iam_policy: gapic_v1.method.wrap_method( + self.set_iam_policy, + default_timeout=60.0, + client_info=client_info, + ), + self.get_iam_policy: gapic_v1.method.wrap_method( + self.get_iam_policy, + default_timeout=60.0, + client_info=client_info, + ), + self.test_iam_permissions: gapic_v1.method.wrap_method( + self.test_iam_permissions, + default_timeout=60.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def list_secrets(self) -> Callable[ + [service.ListSecretsRequest], + Union[ + service.ListSecretsResponse, + Awaitable[service.ListSecretsResponse] + ]]: + raise NotImplementedError() + + @property + def create_secret(self) -> Callable[ + [service.CreateSecretRequest], + Union[ + resources.Secret, + Awaitable[resources.Secret] + ]]: + raise NotImplementedError() + + @property + def add_secret_version(self) -> Callable[ + [service.AddSecretVersionRequest], + Union[ + resources.SecretVersion, + Awaitable[resources.SecretVersion] + ]]: + raise NotImplementedError() + + @property + def get_secret(self) -> Callable[ + [service.GetSecretRequest], + Union[ + resources.Secret, + Awaitable[resources.Secret] + ]]: + raise NotImplementedError() + + @property + def update_secret(self) -> Callable[ + [service.UpdateSecretRequest], + Union[ + resources.Secret, + Awaitable[resources.Secret] + ]]: + raise NotImplementedError() + + @property + def delete_secret(self) -> Callable[ + [service.DeleteSecretRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def list_secret_versions(self) -> Callable[ + [service.ListSecretVersionsRequest], + Union[ + service.ListSecretVersionsResponse, + Awaitable[service.ListSecretVersionsResponse] + ]]: + raise NotImplementedError() + + @property + def get_secret_version(self) -> Callable[ + [service.GetSecretVersionRequest], + Union[ + resources.SecretVersion, + Awaitable[resources.SecretVersion] + ]]: + raise NotImplementedError() + + @property + def access_secret_version(self) -> Callable[ + [service.AccessSecretVersionRequest], + Union[ + service.AccessSecretVersionResponse, + Awaitable[service.AccessSecretVersionResponse] + ]]: + raise NotImplementedError() + + @property + def disable_secret_version(self) -> Callable[ + [service.DisableSecretVersionRequest], + Union[ + resources.SecretVersion, + Awaitable[resources.SecretVersion] + ]]: + raise NotImplementedError() + + @property + def enable_secret_version(self) -> Callable[ + [service.EnableSecretVersionRequest], + Union[ + resources.SecretVersion, + Awaitable[resources.SecretVersion] + ]]: + raise NotImplementedError() + + @property + def destroy_secret_version(self) -> Callable[ + [service.DestroySecretVersionRequest], + Union[ + resources.SecretVersion, + Awaitable[resources.SecretVersion] + ]]: + raise NotImplementedError() + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Union[ + iam_policy_pb2.TestIamPermissionsResponse, + Awaitable[iam_policy_pb2.TestIamPermissionsResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'SecretManagerServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py new file mode 100644 index 0000000..ac32411 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py @@ -0,0 +1,685 @@ +# -*- 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.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO + + +class SecretManagerServiceGrpcTransport(SecretManagerServiceTransport): + """gRPC backend transport for SecretManagerService. + + Secret Manager Service + + Manages secrets and operations using those secrets. Implements a + REST model with the following objects: + + - [Secret][google.cloud.secretmanager.v1.Secret] + - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + + 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 = 'secretmanager.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 = 'secretmanager.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 list_secrets(self) -> Callable[ + [service.ListSecretsRequest], + service.ListSecretsResponse]: + r"""Return a callable for the list secrets method over gRPC. + + Lists [Secrets][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.ListSecretsRequest], + ~.ListSecretsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secrets' not in self._stubs: + self._stubs['list_secrets'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/ListSecrets', + request_serializer=service.ListSecretsRequest.serialize, + response_deserializer=service.ListSecretsResponse.deserialize, + ) + return self._stubs['list_secrets'] + + @property + def create_secret(self) -> Callable[ + [service.CreateSecretRequest], + resources.Secret]: + r"""Return a callable for the create secret method over gRPC. + + Creates a new [Secret][google.cloud.secretmanager.v1.Secret] + containing no + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.CreateSecretRequest], + ~.Secret]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['create_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/CreateSecret', + request_serializer=service.CreateSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['create_secret'] + + @property + def add_secret_version(self) -> Callable[ + [service.AddSecretVersionRequest], + resources.SecretVersion]: + r"""Return a callable for the add secret version method over gRPC. + + Creates a new + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + containing secret data and attaches it to an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.AddSecretVersionRequest], + ~.SecretVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'add_secret_version' not in self._stubs: + self._stubs['add_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/AddSecretVersion', + request_serializer=service.AddSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['add_secret_version'] + + @property + def get_secret(self) -> Callable[ + [service.GetSecretRequest], + resources.Secret]: + r"""Return a callable for the get secret method over gRPC. + + Gets metadata for a given + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.GetSecretRequest], + ~.Secret]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['get_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetSecret', + request_serializer=service.GetSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['get_secret'] + + @property + def update_secret(self) -> Callable[ + [service.UpdateSecretRequest], + resources.Secret]: + r"""Return a callable for the update secret method over gRPC. + + Updates metadata of an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.UpdateSecretRequest], + ~.Secret]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['update_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/UpdateSecret', + request_serializer=service.UpdateSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['update_secret'] + + @property + def delete_secret(self) -> Callable[ + [service.DeleteSecretRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete secret method over gRPC. + + Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.DeleteSecretRequest], + ~.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_secret' not in self._stubs: + self._stubs['delete_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DeleteSecret', + request_serializer=service.DeleteSecretRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_secret'] + + @property + def list_secret_versions(self) -> Callable[ + [service.ListSecretVersionsRequest], + service.ListSecretVersionsResponse]: + r"""Return a callable for the list secret versions method over gRPC. + + Lists + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + This call does not return secret data. + + Returns: + Callable[[~.ListSecretVersionsRequest], + ~.ListSecretVersionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret_versions' not in self._stubs: + self._stubs['list_secret_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/ListSecretVersions', + request_serializer=service.ListSecretVersionsRequest.serialize, + response_deserializer=service.ListSecretVersionsResponse.deserialize, + ) + return self._stubs['list_secret_versions'] + + @property + def get_secret_version(self) -> Callable[ + [service.GetSecretVersionRequest], + resources.SecretVersion]: + r"""Return a callable for the get secret version method over gRPC. + + Gets metadata for a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.GetSecretVersionRequest], + ~.SecretVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret_version' not in self._stubs: + self._stubs['get_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetSecretVersion', + request_serializer=service.GetSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['get_secret_version'] + + @property + def access_secret_version(self) -> Callable[ + [service.AccessSecretVersionRequest], + service.AccessSecretVersionResponse]: + r"""Return a callable for the access secret version method over gRPC. + + Accesses a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.AccessSecretVersionRequest], + ~.AccessSecretVersionResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'access_secret_version' not in self._stubs: + self._stubs['access_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion', + request_serializer=service.AccessSecretVersionRequest.serialize, + response_deserializer=service.AccessSecretVersionResponse.deserialize, + ) + return self._stubs['access_secret_version'] + + @property + def disable_secret_version(self) -> Callable[ + [service.DisableSecretVersionRequest], + resources.SecretVersion]: + r"""Return a callable for the disable secret version method over gRPC. + + Disables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. + + Returns: + Callable[[~.DisableSecretVersionRequest], + ~.SecretVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'disable_secret_version' not in self._stubs: + self._stubs['disable_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DisableSecretVersion', + request_serializer=service.DisableSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['disable_secret_version'] + + @property + def enable_secret_version(self) -> Callable[ + [service.EnableSecretVersionRequest], + resources.SecretVersion]: + r"""Return a callable for the enable secret version method over gRPC. + + Enables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. + + Returns: + Callable[[~.EnableSecretVersionRequest], + ~.SecretVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'enable_secret_version' not in self._stubs: + self._stubs['enable_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/EnableSecretVersion', + request_serializer=service.EnableSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['enable_secret_version'] + + @property + def destroy_secret_version(self) -> Callable[ + [service.DestroySecretVersionRequest], + resources.SecretVersion]: + r"""Return a callable for the destroy secret version method over gRPC. + + Destroys a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] + and irrevocably destroys the secret data. + + Returns: + Callable[[~.DestroySecretVersionRequest], + ~.SecretVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'destroy_secret_version' not in self._stubs: + self._stubs['destroy_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DestroySecretVersion', + request_serializer=service.DestroySecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['destroy_secret_version'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets the access control policy on the specified secret. Replaces + any existing policy. + + Permissions on + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + are enforced according to the policy set on the associated + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.SetIamPolicyRequest], + ~.Policy]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a secret. + Returns empty policy if the secret exists and does not + have a policy set. + + Returns: + Callable[[~.GetIamPolicyRequest], + ~.Policy]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse]: + r"""Return a callable for the test iam permissions method over gRPC. + + Returns permissions that a caller has for the specified secret. + If the secret does not exist, this call returns an empty set of + permissions, not a NOT_FOUND error. + + Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without + warning. + + Returns: + Callable[[~.TestIamPermissionsRequest], + ~.TestIamPermissionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + def close(self): + self.grpc_channel.close() + +__all__ = ( + 'SecretManagerServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..3d01893 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py @@ -0,0 +1,690 @@ +# -*- 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.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import SecretManagerServiceGrpcTransport + + +class SecretManagerServiceGrpcAsyncIOTransport(SecretManagerServiceTransport): + """gRPC AsyncIO backend transport for SecretManagerService. + + Secret Manager Service + + Manages secrets and operations using those secrets. Implements a + REST model with the following objects: + + - [Secret][google.cloud.secretmanager.v1.Secret] + - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + + 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 = 'secretmanager.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 = 'secretmanager.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 list_secrets(self) -> Callable[ + [service.ListSecretsRequest], + Awaitable[service.ListSecretsResponse]]: + r"""Return a callable for the list secrets method over gRPC. + + Lists [Secrets][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.ListSecretsRequest], + Awaitable[~.ListSecretsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secrets' not in self._stubs: + self._stubs['list_secrets'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/ListSecrets', + request_serializer=service.ListSecretsRequest.serialize, + response_deserializer=service.ListSecretsResponse.deserialize, + ) + return self._stubs['list_secrets'] + + @property + def create_secret(self) -> Callable[ + [service.CreateSecretRequest], + Awaitable[resources.Secret]]: + r"""Return a callable for the create secret method over gRPC. + + Creates a new [Secret][google.cloud.secretmanager.v1.Secret] + containing no + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.CreateSecretRequest], + Awaitable[~.Secret]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['create_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/CreateSecret', + request_serializer=service.CreateSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['create_secret'] + + @property + def add_secret_version(self) -> Callable[ + [service.AddSecretVersionRequest], + Awaitable[resources.SecretVersion]]: + r"""Return a callable for the add secret version method over gRPC. + + Creates a new + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + containing secret data and attaches it to an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.AddSecretVersionRequest], + Awaitable[~.SecretVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'add_secret_version' not in self._stubs: + self._stubs['add_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/AddSecretVersion', + request_serializer=service.AddSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['add_secret_version'] + + @property + def get_secret(self) -> Callable[ + [service.GetSecretRequest], + Awaitable[resources.Secret]]: + r"""Return a callable for the get secret method over gRPC. + + Gets metadata for a given + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.GetSecretRequest], + Awaitable[~.Secret]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['get_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetSecret', + request_serializer=service.GetSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['get_secret'] + + @property + def update_secret(self) -> Callable[ + [service.UpdateSecretRequest], + Awaitable[resources.Secret]]: + r"""Return a callable for the update secret method over gRPC. + + Updates metadata of an existing + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.UpdateSecretRequest], + Awaitable[~.Secret]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret' not in self._stubs: + self._stubs['update_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/UpdateSecret', + request_serializer=service.UpdateSecretRequest.serialize, + response_deserializer=resources.Secret.deserialize, + ) + return self._stubs['update_secret'] + + @property + def delete_secret(self) -> Callable[ + [service.DeleteSecretRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete secret method over gRPC. + + Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.DeleteSecretRequest], + 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_secret' not in self._stubs: + self._stubs['delete_secret'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DeleteSecret', + request_serializer=service.DeleteSecretRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_secret'] + + @property + def list_secret_versions(self) -> Callable[ + [service.ListSecretVersionsRequest], + Awaitable[service.ListSecretVersionsResponse]]: + r"""Return a callable for the list secret versions method over gRPC. + + Lists + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + This call does not return secret data. + + Returns: + Callable[[~.ListSecretVersionsRequest], + Awaitable[~.ListSecretVersionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret_versions' not in self._stubs: + self._stubs['list_secret_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/ListSecretVersions', + request_serializer=service.ListSecretVersionsRequest.serialize, + response_deserializer=service.ListSecretVersionsResponse.deserialize, + ) + return self._stubs['list_secret_versions'] + + @property + def get_secret_version(self) -> Callable[ + [service.GetSecretVersionRequest], + Awaitable[resources.SecretVersion]]: + r"""Return a callable for the get secret version method over gRPC. + + Gets metadata for a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.GetSecretVersionRequest], + Awaitable[~.SecretVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_secret_version' not in self._stubs: + self._stubs['get_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetSecretVersion', + request_serializer=service.GetSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['get_secret_version'] + + @property + def access_secret_version(self) -> Callable[ + [service.AccessSecretVersionRequest], + Awaitable[service.AccessSecretVersionResponse]]: + r"""Return a callable for the access secret version method over gRPC. + + Accesses a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + + ``projects/*/secrets/*/versions/latest`` is an alias to the most + recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Returns: + Callable[[~.AccessSecretVersionRequest], + Awaitable[~.AccessSecretVersionResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'access_secret_version' not in self._stubs: + self._stubs['access_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion', + request_serializer=service.AccessSecretVersionRequest.serialize, + response_deserializer=service.AccessSecretVersionResponse.deserialize, + ) + return self._stubs['access_secret_version'] + + @property + def disable_secret_version(self) -> Callable[ + [service.DisableSecretVersionRequest], + Awaitable[resources.SecretVersion]]: + r"""Return a callable for the disable secret version method over gRPC. + + Disables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. + + Returns: + Callable[[~.DisableSecretVersionRequest], + Awaitable[~.SecretVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'disable_secret_version' not in self._stubs: + self._stubs['disable_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DisableSecretVersion', + request_serializer=service.DisableSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['disable_secret_version'] + + @property + def enable_secret_version(self) -> Callable[ + [service.EnableSecretVersionRequest], + Awaitable[resources.SecretVersion]]: + r"""Return a callable for the enable secret version method over gRPC. + + Enables a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. + + Returns: + Callable[[~.EnableSecretVersionRequest], + Awaitable[~.SecretVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'enable_secret_version' not in self._stubs: + self._stubs['enable_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/EnableSecretVersion', + request_serializer=service.EnableSecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['enable_secret_version'] + + @property + def destroy_secret_version(self) -> Callable[ + [service.DestroySecretVersionRequest], + Awaitable[resources.SecretVersion]]: + r"""Return a callable for the destroy secret version method over gRPC. + + Destroys a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Sets the + [state][google.cloud.secretmanager.v1.SecretVersion.state] of + the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to + [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] + and irrevocably destroys the secret data. + + Returns: + Callable[[~.DestroySecretVersionRequest], + Awaitable[~.SecretVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'destroy_secret_version' not in self._stubs: + self._stubs['destroy_secret_version'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/DestroySecretVersion', + request_serializer=service.DestroySecretVersionRequest.serialize, + response_deserializer=resources.SecretVersion.deserialize, + ) + return self._stubs['destroy_secret_version'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets the access control policy on the specified secret. Replaces + any existing policy. + + Permissions on + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + are enforced according to the policy set on the associated + [Secret][google.cloud.secretmanager.v1.Secret]. + + Returns: + Callable[[~.SetIamPolicyRequest], + Awaitable[~.Policy]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a secret. + Returns empty policy if the secret exists and does not + have a policy set. + + Returns: + Callable[[~.GetIamPolicyRequest], + Awaitable[~.Policy]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: + r"""Return a callable for the test iam permissions method over gRPC. + + Returns permissions that a caller has for the specified secret. + If the secret does not exist, this call returns an empty set of + permissions, not a NOT_FOUND error. + + Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without + warning. + + Returns: + Callable[[~.TestIamPermissionsRequest], + Awaitable[~.TestIamPermissionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( + '/google.cloud.secretmanager.v1.SecretManagerService/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'SecretManagerServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py new file mode 100644 index 0000000..61a50e0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py @@ -0,0 +1,70 @@ +# -*- 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 .resources import ( + CustomerManagedEncryption, + CustomerManagedEncryptionStatus, + Replication, + ReplicationStatus, + Rotation, + Secret, + SecretPayload, + SecretVersion, + Topic, +) +from .service import ( + AccessSecretVersionRequest, + AccessSecretVersionResponse, + AddSecretVersionRequest, + CreateSecretRequest, + DeleteSecretRequest, + DestroySecretVersionRequest, + DisableSecretVersionRequest, + EnableSecretVersionRequest, + GetSecretRequest, + GetSecretVersionRequest, + ListSecretsRequest, + ListSecretsResponse, + ListSecretVersionsRequest, + ListSecretVersionsResponse, + UpdateSecretRequest, +) + +__all__ = ( + 'CustomerManagedEncryption', + 'CustomerManagedEncryptionStatus', + 'Replication', + 'ReplicationStatus', + 'Rotation', + 'Secret', + 'SecretPayload', + 'SecretVersion', + 'Topic', + 'AccessSecretVersionRequest', + 'AccessSecretVersionResponse', + 'AddSecretVersionRequest', + 'CreateSecretRequest', + 'DeleteSecretRequest', + 'DestroySecretVersionRequest', + 'DisableSecretVersionRequest', + 'EnableSecretVersionRequest', + 'GetSecretRequest', + 'GetSecretVersionRequest', + 'ListSecretsRequest', + 'ListSecretsResponse', + 'ListSecretVersionsRequest', + 'ListSecretVersionsResponse', + 'UpdateSecretRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py new file mode 100644 index 0000000..04a5cf3 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py @@ -0,0 +1,558 @@ +# -*- 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 duration_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.secretmanager.v1', + manifest={ + 'Secret', + 'SecretVersion', + 'Replication', + 'CustomerManagedEncryption', + 'ReplicationStatus', + 'CustomerManagedEncryptionStatus', + 'Topic', + 'Rotation', + 'SecretPayload', + }, +) + + +class Secret(proto.Message): + r"""A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret + whose value and versions can be accessed. + + A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero + or more + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that + represent the secret data. + + Attributes: + name (str): + Output only. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] in the format + ``projects/*/secrets/*``. + replication (google.cloud.secretmanager_v1.types.Replication): + Required. Immutable. The replication policy of the secret + data attached to the + [Secret][google.cloud.secretmanager.v1.Secret]. + + The replication policy cannot be changed after the Secret + has been created. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which the + [Secret][google.cloud.secretmanager.v1.Secret] was created. + labels (Sequence[google.cloud.secretmanager_v1.types.Secret.LabelsEntry]): + The labels assigned to this Secret. + + Label keys must be between 1 and 63 characters long, have a + UTF-8 encoding of maximum 128 bytes, and must conform to the + following PCRE regular expression: + ``[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`` + + Label values must be between 0 and 63 characters long, have + a UTF-8 encoding of maximum 128 bytes, and must conform to + the following PCRE regular expression: + ``[\p{Ll}\p{Lo}\p{N}_-]{0,63}`` + + No more than 64 labels can be assigned to a given resource. + topics (Sequence[google.cloud.secretmanager_v1.types.Topic]): + Optional. A list of up to 10 Pub/Sub topics + to which messages are published when control + plane operations are called on the secret or its + versions. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. Timestamp in UTC when the + [Secret][google.cloud.secretmanager.v1.Secret] is scheduled + to expire. This is always provided on output, regardless of + what was sent on input. + ttl (google.protobuf.duration_pb2.Duration): + Input only. The TTL for the + [Secret][google.cloud.secretmanager.v1.Secret]. + etag (str): + Optional. Etag of the currently stored + [Secret][google.cloud.secretmanager.v1.Secret]. + rotation (google.cloud.secretmanager_v1.types.Rotation): + Optional. Rotation policy attached to the + [Secret][google.cloud.secretmanager.v1.Secret]. May be + excluded if there is no rotation policy. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + replication = proto.Field( + proto.MESSAGE, + number=2, + message='Replication', + ) + create_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=4, + ) + topics = proto.RepeatedField( + proto.MESSAGE, + number=5, + message='Topic', + ) + expire_time = proto.Field( + proto.MESSAGE, + number=6, + oneof='expiration', + message=timestamp_pb2.Timestamp, + ) + ttl = proto.Field( + proto.MESSAGE, + number=7, + oneof='expiration', + message=duration_pb2.Duration, + ) + etag = proto.Field( + proto.STRING, + number=8, + ) + rotation = proto.Field( + proto.MESSAGE, + number=9, + message='Rotation', + ) + + +class SecretVersion(proto.Message): + r"""A secret version resource in the Secret Manager API. + + Attributes: + name (str): + Output only. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + IDs in a [Secret][google.cloud.secretmanager.v1.Secret] + start at 1 and are incremented for each subsequent version + of the secret. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + was created. + destroy_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time this + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + was destroyed. Only present if + [state][google.cloud.secretmanager.v1.SecretVersion.state] + is + [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]. + state (google.cloud.secretmanager_v1.types.SecretVersion.State): + Output only. The current state of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + replication_status (google.cloud.secretmanager_v1.types.ReplicationStatus): + The replication status of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + etag (str): + Output only. Etag of the currently stored + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + """ + class State(proto.Enum): + r"""The state of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], + indicating if it can be accessed. + """ + STATE_UNSPECIFIED = 0 + ENABLED = 1 + DISABLED = 2 + DESTROYED = 3 + + name = proto.Field( + proto.STRING, + number=1, + ) + create_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + destroy_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + state = proto.Field( + proto.ENUM, + number=4, + enum=State, + ) + replication_status = proto.Field( + proto.MESSAGE, + number=5, + message='ReplicationStatus', + ) + etag = proto.Field( + proto.STRING, + number=6, + ) + + +class Replication(proto.Message): + r"""A policy that defines the replication and encryption + configuration of data. + + Attributes: + automatic (google.cloud.secretmanager_v1.types.Replication.Automatic): + The [Secret][google.cloud.secretmanager.v1.Secret] will + automatically be replicated without any restrictions. + user_managed (google.cloud.secretmanager_v1.types.Replication.UserManaged): + The [Secret][google.cloud.secretmanager.v1.Secret] will only + be replicated into the locations specified. + """ + + class Automatic(proto.Message): + r"""A replication policy that replicates the + [Secret][google.cloud.secretmanager.v1.Secret] payload without any + restrictions. + + Attributes: + customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryption): + Optional. The customer-managed encryption configuration of + the [Secret][google.cloud.secretmanager.v1.Secret]. If no + configuration is provided, Google-managed default encryption + is used. + + Updates to the + [Secret][google.cloud.secretmanager.v1.Secret] encryption + configuration only apply to + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + added afterwards. They do not apply retroactively to + existing + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + """ + + customer_managed_encryption = proto.Field( + proto.MESSAGE, + number=1, + message='CustomerManagedEncryption', + ) + + class UserManaged(proto.Message): + r"""A replication policy that replicates the + [Secret][google.cloud.secretmanager.v1.Secret] payload into the + locations specified in [Secret.replication.user_managed.replicas][] + + Attributes: + replicas (Sequence[google.cloud.secretmanager_v1.types.Replication.UserManaged.Replica]): + Required. The list of Replicas for this + [Secret][google.cloud.secretmanager.v1.Secret]. + + Cannot be empty. + """ + + class Replica(proto.Message): + r"""Represents a Replica for this + [Secret][google.cloud.secretmanager.v1.Secret]. + + Attributes: + location (str): + The canonical IDs of the location to replicate data. For + example: ``"us-east1"``. + customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryption): + Optional. The customer-managed encryption configuration of + the [User-Managed Replica][Replication.UserManaged.Replica]. + If no configuration is provided, Google-managed default + encryption is used. + + Updates to the + [Secret][google.cloud.secretmanager.v1.Secret] encryption + configuration only apply to + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + added afterwards. They do not apply retroactively to + existing + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + """ + + location = proto.Field( + proto.STRING, + number=1, + ) + customer_managed_encryption = proto.Field( + proto.MESSAGE, + number=2, + message='CustomerManagedEncryption', + ) + + replicas = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Replication.UserManaged.Replica', + ) + + automatic = proto.Field( + proto.MESSAGE, + number=1, + oneof='replication', + message=Automatic, + ) + user_managed = proto.Field( + proto.MESSAGE, + number=2, + oneof='replication', + message=UserManaged, + ) + + +class CustomerManagedEncryption(proto.Message): + r"""Configuration for encrypting secret payloads using customer- + anaged encryption keys (CMEK). + + Attributes: + kms_key_name (str): + Required. The resource name of the Cloud KMS CryptoKey used + to encrypt secret payloads. + + For secrets using the + [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged] + replication policy type, Cloud KMS CryptoKeys must reside in + the same location as the [replica + location][Secret.UserManaged.Replica.location]. + + For secrets using the + [Automatic][google.cloud.secretmanager.v1.Replication.Automatic] + replication policy type, Cloud KMS CryptoKeys must reside in + ``global``. + + The expected format is + ``projects/*/locations/*/keyRings/*/cryptoKeys/*``. + """ + + kms_key_name = proto.Field( + proto.STRING, + number=1, + ) + + +class ReplicationStatus(proto.Message): + r"""The replication status of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Attributes: + automatic (google.cloud.secretmanager_v1.types.ReplicationStatus.AutomaticStatus): + Describes the replication status of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + with automatic replication. + + Only populated if the parent + [Secret][google.cloud.secretmanager.v1.Secret] has an + automatic replication policy. + user_managed (google.cloud.secretmanager_v1.types.ReplicationStatus.UserManagedStatus): + Describes the replication status of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + with user-managed replication. + + Only populated if the parent + [Secret][google.cloud.secretmanager.v1.Secret] has a + user-managed replication policy. + """ + + class AutomaticStatus(proto.Message): + r"""The replication status of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using + automatic replication. + + Only populated if the parent + [Secret][google.cloud.secretmanager.v1.Secret] has an automatic + replication policy. + + Attributes: + customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryptionStatus): + Output only. The customer-managed encryption status of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + Only populated if customer-managed encryption is used. + """ + + customer_managed_encryption = proto.Field( + proto.MESSAGE, + number=1, + message='CustomerManagedEncryptionStatus', + ) + + class UserManagedStatus(proto.Message): + r"""The replication status of a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using + user-managed replication. + + Only populated if the parent + [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed + replication policy. + + Attributes: + replicas (Sequence[google.cloud.secretmanager_v1.types.ReplicationStatus.UserManagedStatus.ReplicaStatus]): + Output only. The list of replica statuses for the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + """ + + class ReplicaStatus(proto.Message): + r"""Describes the status of a user-managed replica for the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Attributes: + location (str): + Output only. The canonical ID of the replica location. For + example: ``"us-east1"``. + customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryptionStatus): + Output only. The customer-managed encryption status of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + Only populated if customer-managed encryption is used. + """ + + location = proto.Field( + proto.STRING, + number=1, + ) + customer_managed_encryption = proto.Field( + proto.MESSAGE, + number=2, + message='CustomerManagedEncryptionStatus', + ) + + replicas = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='ReplicationStatus.UserManagedStatus.ReplicaStatus', + ) + + automatic = proto.Field( + proto.MESSAGE, + number=1, + oneof='replication_status', + message=AutomaticStatus, + ) + user_managed = proto.Field( + proto.MESSAGE, + number=2, + oneof='replication_status', + message=UserManagedStatus, + ) + + +class CustomerManagedEncryptionStatus(proto.Message): + r"""Describes the status of customer-managed encryption. + + Attributes: + kms_key_version_name (str): + Required. The resource name of the Cloud KMS + CryptoKeyVersion used to encrypt the secret payload, in the + following format: + ``projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*``. + """ + + kms_key_version_name = proto.Field( + proto.STRING, + number=1, + ) + + +class Topic(proto.Message): + r"""A Pub/Sub topic which Secret Manager will publish to when + control plane events occur on this secret. + + Attributes: + name (str): + Required. The resource name of the Pub/Sub topic that will + be published to, in the following format: + ``projects/*/topics/*``. For publication to succeed, the + Secret Manager P4SA must have ``pubsub.publisher`` + permissions on the topic. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class Rotation(proto.Message): + r"""The rotation time and period for a + [Secret][google.cloud.secretmanager.v1.Secret]. At + next_rotation_time, Secret Manager will send a Pub/Sub notification + to the topics configured on the Secret. + [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be + set to configure rotation. + + Attributes: + next_rotation_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. Timestamp in UTC at which the + [Secret][google.cloud.secretmanager.v1.Secret] is scheduled + to rotate. Cannot be set to less than 300s (5 min) in the + future and at most 3153600000s (100 years). + + [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + MUST be set if + [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] + is set. + rotation_period (google.protobuf.duration_pb2.Duration): + Input only. The Duration between rotation notifications. + Must be in seconds and at least 3600s (1h) and at most + 3153600000s (100 years). + + If + [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] + is set, + [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + must be set. + [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + will be advanced by this period when the service + automatically sends rotation notifications. + """ + + next_rotation_time = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + rotation_period = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + +class SecretPayload(proto.Message): + r"""A secret payload resource in the Secret Manager API. This contains + the sensitive secret payload that is associated with a + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Attributes: + data (bytes): + The secret data. Must be no larger than + 64KiB. + """ + + data = proto.Field( + proto.BYTES, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py new file mode 100644 index 0000000..f392df8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py @@ -0,0 +1,488 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.secretmanager_v1.types import resources +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.secretmanager.v1', + manifest={ + 'ListSecretsRequest', + 'ListSecretsResponse', + 'CreateSecretRequest', + 'AddSecretVersionRequest', + 'GetSecretRequest', + 'ListSecretVersionsRequest', + 'ListSecretVersionsResponse', + 'GetSecretVersionRequest', + 'UpdateSecretRequest', + 'AccessSecretVersionRequest', + 'AccessSecretVersionResponse', + 'DeleteSecretRequest', + 'DisableSecretVersionRequest', + 'EnableSecretVersionRequest', + 'DestroySecretVersionRequest', + }, +) + + +class ListSecretsRequest(proto.Message): + r"""Request message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + + Attributes: + parent (str): + Required. The resource name of the project associated with + the [Secrets][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*``. + page_size (int): + Optional. The maximum number of results to be + returned in a single page. If set to 0, the + server decides the number of results to return. + If the number is greater than 25000, it is + capped at 25000. + page_token (str): + Optional. Pagination token, returned earlier via + [ListSecretsResponse.next_page_token][google.cloud.secretmanager.v1.ListSecretsResponse.next_page_token]. + filter (str): + Optional. Filter string, adhering to the rules in + `List-operation + filtering `__. + List only secrets matching the filter. If filter is empty, + all secrets are listed. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + + +class ListSecretsResponse(proto.Message): + r"""Response message for + [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. + + Attributes: + secrets (Sequence[google.cloud.secretmanager_v1.types.Secret]): + The list of [Secrets][google.cloud.secretmanager.v1.Secret] + sorted in reverse by create_time (newest first). + next_page_token (str): + A token to retrieve the next page of results. Pass this + value in + [ListSecretsRequest.page_token][google.cloud.secretmanager.v1.ListSecretsRequest.page_token] + to retrieve the next page. + total_size (int): + The total number of + [Secrets][google.cloud.secretmanager.v1.Secret]. + """ + + @property + def raw_page(self): + return self + + secrets = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resources.Secret, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + total_size = proto.Field( + proto.INT32, + number=3, + ) + + +class CreateSecretRequest(proto.Message): + r"""Request message for + [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. + + Attributes: + parent (str): + Required. The resource name of the project to associate with + the [Secret][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*``. + secret_id (str): + Required. This must be unique within the project. + + A secret ID is a string with a maximum length of 255 + characters and can contain uppercase and lowercase letters, + numerals, and the hyphen (``-``) and underscore (``_``) + characters. + secret (google.cloud.secretmanager_v1.types.Secret): + Required. A [Secret][google.cloud.secretmanager.v1.Secret] + with initial field values. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + secret_id = proto.Field( + proto.STRING, + number=2, + ) + secret = proto.Field( + proto.MESSAGE, + number=3, + message=resources.Secret, + ) + + +class AddSecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. + + Attributes: + parent (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to associate + with the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*``. + payload (google.cloud.secretmanager_v1.types.SecretPayload): + Required. The secret payload of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + payload = proto.Field( + proto.MESSAGE, + number=2, + message=resources.SecretPayload, + ) + + +class GetSecretRequest(proto.Message): + r"""Request message for + [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. + + Attributes: + name (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret], in the + format ``projects/*/secrets/*``. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class ListSecretVersionsRequest(proto.Message): + r"""Request message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + + Attributes: + parent (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] associated + with the + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + to list, in the format ``projects/*/secrets/*``. + page_size (int): + Optional. The maximum number of results to be + returned in a single page. If set to 0, the + server decides the number of results to return. + If the number is greater than 25000, it is + capped at 25000. + page_token (str): + Optional. Pagination token, returned earlier via + ListSecretVersionsResponse.next_page_token][]. + filter (str): + Optional. Filter string, adhering to the rules in + `List-operation + filtering `__. + List only secret versions matching the filter. If filter is + empty, all secret versions are listed. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + + +class ListSecretVersionsResponse(proto.Message): + r"""Response message for + [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. + + Attributes: + versions (Sequence[google.cloud.secretmanager_v1.types.SecretVersion]): + The list of + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] + sorted in reverse by create_time (newest first). + next_page_token (str): + A token to retrieve the next page of results. Pass this + value in + [ListSecretVersionsRequest.page_token][google.cloud.secretmanager.v1.ListSecretVersionsRequest.page_token] + to retrieve the next page. + total_size (int): + The total number of + [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + """ + + @property + def raw_page(self): + return self + + versions = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resources.SecretVersion, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + total_size = proto.Field( + proto.INT32, + number=3, + ) + + +class GetSecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. + + Attributes: + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to the + most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateSecretRequest(proto.Message): + r"""Request message for + [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. + + Attributes: + secret (google.cloud.secretmanager_v1.types.Secret): + Required. [Secret][google.cloud.secretmanager.v1.Secret] + with updated field values. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Specifies the fields to be updated. + """ + + secret = proto.Field( + proto.MESSAGE, + number=1, + message=resources.Secret, + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class AccessSecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + + Attributes: + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + + ``projects/*/secrets/*/versions/latest`` is an alias to the + most recently created + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class AccessSecretVersionResponse(proto.Message): + r"""Response message for + [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. + + Attributes: + name (str): + The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + in the format ``projects/*/secrets/*/versions/*``. + payload (google.cloud.secretmanager_v1.types.SecretPayload): + Secret payload + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + payload = proto.Field( + proto.MESSAGE, + number=2, + message=resources.SecretPayload, + ) + + +class DeleteSecretRequest(proto.Message): + r"""Request message for + [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. + + Attributes: + name (str): + Required. The resource name of the + [Secret][google.cloud.secretmanager.v1.Secret] to delete in + the format ``projects/*/secrets/*``. + etag (str): + Optional. Etag of the + [Secret][google.cloud.secretmanager.v1.Secret]. The request + succeeds if it matches the etag of the currently stored + secret object. If the etag is omitted, the request succeeds. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + etag = proto.Field( + proto.STRING, + number=2, + ) + + +class DisableSecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. + + Attributes: + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to disable in the format + ``projects/*/secrets/*/versions/*``. + etag (str): + Optional. Etag of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + The request succeeds if it matches the etag of the currently + stored secret version object. If the etag is omitted, the + request succeeds. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + etag = proto.Field( + proto.STRING, + number=2, + ) + + +class EnableSecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. + + Attributes: + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to enable in the format ``projects/*/secrets/*/versions/*``. + etag (str): + Optional. Etag of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + The request succeeds if it matches the etag of the currently + stored secret version object. If the etag is omitted, the + request succeeds. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + etag = proto.Field( + proto.STRING, + number=2, + ) + + +class DestroySecretVersionRequest(proto.Message): + r"""Request message for + [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. + + Attributes: + name (str): + Required. The resource name of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] + to destroy in the format + ``projects/*/secrets/*/versions/*``. + etag (str): + Optional. Etag of the + [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + The request succeeds if it matches the etag of the currently + stored secret version object. If the etag is omitted, the + request succeeds. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + etag = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /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 0000000..798947b --- /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/secretmanager_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_secretmanager_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_secretmanager_v1_keywords.py new file mode 100644 index 0000000..1f5e1da --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_secretmanager_v1_keywords.py @@ -0,0 +1,190 @@ +#! /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 secretmanagerCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'access_secret_version': ('name', ), + 'add_secret_version': ('parent', 'payload', ), + 'create_secret': ('parent', 'secret_id', 'secret', ), + 'delete_secret': ('name', 'etag', ), + 'destroy_secret_version': ('name', 'etag', ), + 'disable_secret_version': ('name', 'etag', ), + 'enable_secret_version': ('name', 'etag', ), + 'get_iam_policy': ('resource', 'options', ), + 'get_secret': ('name', ), + 'get_secret_version': ('name', ), + 'list_secrets': ('parent', 'page_size', 'page_token', 'filter', ), + 'list_secret_versions': ('parent', 'page_size', 'page_token', 'filter', ), + 'set_iam_policy': ('resource', 'policy', ), + 'test_iam_permissions': ('resource', 'permissions', ), + 'update_secret': ('secret', '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=secretmanagerCallTransformer(), +): + """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 secretmanager client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..f519a65 --- /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-secretmanager', + 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', 'grpc-google-iam-v1 >= 0.12.3, < 0.13dev', ), + 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 0000000..b54a5fc --- /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 0000000..b54a5fc --- /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 0000000..b54a5fc --- /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/secretmanager_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_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/secretmanager_v1/test_secret_manager_service.py b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py new file mode 100644 index 0000000..dd82562 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py @@ -0,0 +1,4780 @@ +# -*- 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.secretmanager_v1.services.secret_manager_service import SecretManagerServiceAsyncClient +from google.cloud.secretmanager_v1.services.secret_manager_service import SecretManagerServiceClient +from google.cloud.secretmanager_v1.services.secret_manager_service import pagers +from google.cloud.secretmanager_v1.services.secret_manager_service import transports +from google.cloud.secretmanager_v1.services.secret_manager_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.secretmanager_v1.types import resources +from google.cloud.secretmanager_v1.types import service +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import options_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import expr_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 SecretManagerServiceClient._get_default_mtls_endpoint(None) is None + assert SecretManagerServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SecretManagerServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SecretManagerServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SecretManagerServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SecretManagerServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + SecretManagerServiceClient, + SecretManagerServiceAsyncClient, +]) +def test_secret_manager_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 == 'secretmanager.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.SecretManagerServiceGrpcTransport, "grpc"), + (transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_secret_manager_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", [ + SecretManagerServiceClient, + SecretManagerServiceAsyncClient, +]) +def test_secret_manager_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 == 'secretmanager.googleapis.com:443' + + +def test_secret_manager_service_client_get_transport_class(): + transport = SecretManagerServiceClient.get_transport_class() + available_transports = [ + transports.SecretManagerServiceGrpcTransport, + ] + assert transport in available_transports + + transport = SecretManagerServiceClient.get_transport_class("grpc") + assert transport == transports.SecretManagerServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), + (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(SecretManagerServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceClient)) +@mock.patch.object(SecretManagerServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceAsyncClient)) +def test_secret_manager_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(SecretManagerServiceClient, '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(SecretManagerServiceClient, '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", [ + (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc", "true"), + (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc", "false"), + (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(SecretManagerServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceClient)) +@mock.patch.object(SecretManagerServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_secret_manager_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", [ + (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), + (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_secret_manager_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", [ + (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), + (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_secret_manager_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_secret_manager_service_client_client_options_from_dict(): + with mock.patch('google.cloud.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SecretManagerServiceClient( + 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_list_secrets(transport: str = 'grpc', request_type=service.ListSecretsRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secrets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretsResponse( + next_page_token='next_page_token_value', + total_size=1086, + ) + response = client.list_secrets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSecretsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.total_size == 1086 + + +def test_list_secrets_from_dict(): + test_list_secrets(request_type=dict) + + +def test_list_secrets_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 = SecretManagerServiceClient( + 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_secrets), + '__call__') as call: + client.list_secrets() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretsRequest() + + +@pytest.mark.asyncio +async def test_list_secrets_async(transport: str = 'grpc_asyncio', request_type=service.ListSecretsRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secrets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse( + next_page_token='next_page_token_value', + total_size=1086, + )) + response = await client.list_secrets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSecretsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.total_size == 1086 + + +@pytest.mark.asyncio +async def test_list_secrets_async_from_dict(): + await test_list_secrets_async(request_type=dict) + + +def test_list_secrets_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.ListSecretsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + call.return_value = service.ListSecretsResponse() + client.list_secrets(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_secrets_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.ListSecretsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse()) + await client.list_secrets(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_secrets_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_secrets( + 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_secrets_flattened_error(): + client = SecretManagerServiceClient( + 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_secrets( + service.ListSecretsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_secrets_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_secrets( + 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_secrets_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secrets( + service.ListSecretsRequest(), + parent='parent_value', + ) + + +def test_list_secrets_pager(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + resources.Secret(), + ], + next_page_token='abc', + ), + service.ListSecretsResponse( + secrets=[], + next_page_token='def', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + ], + next_page_token='ghi', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_secrets(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, resources.Secret) + for i in results) + +def test_list_secrets_pages(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + resources.Secret(), + ], + next_page_token='abc', + ), + service.ListSecretsResponse( + secrets=[], + next_page_token='def', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + ], + next_page_token='ghi', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + ], + ), + RuntimeError, + ) + pages = list(client.list_secrets(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_secrets_async_pager(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + resources.Secret(), + ], + next_page_token='abc', + ), + service.ListSecretsResponse( + secrets=[], + next_page_token='def', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + ], + next_page_token='ghi', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_secrets(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, resources.Secret) + for i in responses) + +@pytest.mark.asyncio +async def test_list_secrets_async_pages(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secrets), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + resources.Secret(), + ], + next_page_token='abc', + ), + service.ListSecretsResponse( + secrets=[], + next_page_token='def', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + ], + next_page_token='ghi', + ), + service.ListSecretsResponse( + secrets=[ + resources.Secret(), + resources.Secret(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_secrets(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_create_secret(transport: str = 'grpc', request_type=service.CreateSecretRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret( + name='name_value', + etag='etag_value', + expire_time=timestamp_pb2.Timestamp(seconds=751), + ) + response = client.create_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +def test_create_secret_from_dict(): + test_create_secret(request_type=dict) + + +def test_create_secret_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 = SecretManagerServiceClient( + 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_secret), + '__call__') as call: + client.create_secret() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateSecretRequest() + + +@pytest.mark.asyncio +async def test_create_secret_async(transport: str = 'grpc_asyncio', request_type=service.CreateSecretRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( + name='name_value', + etag='etag_value', + )) + response = await client.create_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_create_secret_async_from_dict(): + await test_create_secret_async(request_type=dict) + + +def test_create_secret_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.CreateSecretRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_secret), + '__call__') as call: + call.return_value = resources.Secret() + client.create_secret(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_secret_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.CreateSecretRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_secret), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + await client.create_secret(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_secret_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_secret( + parent='parent_value', + secret_id='secret_id_value', + secret=resources.Secret(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].secret_id == 'secret_id_value' + assert args[0].secret == resources.Secret(name='name_value') + + +def test_create_secret_flattened_error(): + client = SecretManagerServiceClient( + 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_secret( + service.CreateSecretRequest(), + parent='parent_value', + secret_id='secret_id_value', + secret=resources.Secret(name='name_value'), + ) + + +@pytest.mark.asyncio +async def test_create_secret_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_secret( + parent='parent_value', + secret_id='secret_id_value', + secret=resources.Secret(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].secret_id == 'secret_id_value' + assert args[0].secret == resources.Secret(name='name_value') + + +@pytest.mark.asyncio +async def test_create_secret_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret( + service.CreateSecretRequest(), + parent='parent_value', + secret_id='secret_id_value', + secret=resources.Secret(name='name_value'), + ) + + +def test_add_secret_version(transport: str = 'grpc', request_type=service.AddSecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + ) + response = client.add_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.AddSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +def test_add_secret_version_from_dict(): + test_add_secret_version(request_type=dict) + + +def test_add_secret_version_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 = SecretManagerServiceClient( + 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.add_secret_version), + '__call__') as call: + client.add_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.AddSecretVersionRequest() + + +@pytest.mark.asyncio +async def test_add_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.AddSecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + )) + response = await client.add_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.AddSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_add_secret_version_async_from_dict(): + await test_add_secret_version_async(request_type=dict) + + +def test_add_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.AddSecretVersionRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + call.return_value = resources.SecretVersion() + client.add_secret_version(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_add_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.AddSecretVersionRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + await client.add_secret_version(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_add_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.add_secret_version( + parent='parent_value', + payload=resources.SecretPayload(data=b'data_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].payload == resources.SecretPayload(data=b'data_blob') + + +def test_add_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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.add_secret_version( + service.AddSecretVersionRequest(), + parent='parent_value', + payload=resources.SecretPayload(data=b'data_blob'), + ) + + +@pytest.mark.asyncio +async def test_add_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.add_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.add_secret_version( + parent='parent_value', + payload=resources.SecretPayload(data=b'data_blob'), + ) + + # 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].payload == resources.SecretPayload(data=b'data_blob') + + +@pytest.mark.asyncio +async def test_add_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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.add_secret_version( + service.AddSecretVersionRequest(), + parent='parent_value', + payload=resources.SecretPayload(data=b'data_blob'), + ) + + +def test_get_secret(transport: str = 'grpc', request_type=service.GetSecretRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret( + name='name_value', + etag='etag_value', + expire_time=timestamp_pb2.Timestamp(seconds=751), + ) + response = client.get_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +def test_get_secret_from_dict(): + test_get_secret(request_type=dict) + + +def test_get_secret_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 = SecretManagerServiceClient( + 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_secret), + '__call__') as call: + client.get_secret() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretRequest() + + +@pytest.mark.asyncio +async def test_get_secret_async(transport: str = 'grpc_asyncio', request_type=service.GetSecretRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( + name='name_value', + etag='etag_value', + )) + response = await client.get_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_secret_async_from_dict(): + await test_get_secret_async(request_type=dict) + + +def test_get_secret_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.GetSecretRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret), + '__call__') as call: + call.return_value = resources.Secret() + client.get_secret(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_secret_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.GetSecretRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + await client.get_secret(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_secret_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_secret( + 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_secret_flattened_error(): + client = SecretManagerServiceClient( + 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_secret( + service.GetSecretRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_secret_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_secret( + 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_secret_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret( + service.GetSecretRequest(), + name='name_value', + ) + + +def test_update_secret(transport: str = 'grpc', request_type=service.UpdateSecretRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret( + name='name_value', + etag='etag_value', + expire_time=timestamp_pb2.Timestamp(seconds=751), + ) + response = client.update_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +def test_update_secret_from_dict(): + test_update_secret(request_type=dict) + + +def test_update_secret_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 = SecretManagerServiceClient( + 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_secret), + '__call__') as call: + client.update_secret() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateSecretRequest() + + +@pytest.mark.asyncio +async def test_update_secret_async(transport: str = 'grpc_asyncio', request_type=service.UpdateSecretRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( + name='name_value', + etag='etag_value', + )) + response = await client.update_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateSecretRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Secret) + assert response.name == 'name_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_update_secret_async_from_dict(): + await test_update_secret_async(request_type=dict) + + +def test_update_secret_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.UpdateSecretRequest() + + request.secret.name = 'secret.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_secret), + '__call__') as call: + call.return_value = resources.Secret() + client.update_secret(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', + 'secret.name=secret.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_secret_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.UpdateSecretRequest() + + request.secret.name = 'secret.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_secret), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + await client.update_secret(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', + 'secret.name=secret.name/value', + ) in kw['metadata'] + + +def test_update_secret_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_secret( + secret=resources.Secret(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].secret == resources.Secret(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_secret_flattened_error(): + client = SecretManagerServiceClient( + 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_secret( + service.UpdateSecretRequest(), + secret=resources.Secret(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_secret_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.Secret() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_secret( + secret=resources.Secret(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].secret == resources.Secret(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_secret_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret( + service.UpdateSecretRequest(), + secret=resources.Secret(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_secret(transport: str = 'grpc', request_type=service.DeleteSecretRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteSecretRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_secret_from_dict(): + test_delete_secret(request_type=dict) + + +def test_delete_secret_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 = SecretManagerServiceClient( + 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_secret), + '__call__') as call: + client.delete_secret() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteSecretRequest() + + +@pytest.mark.asyncio +async def test_delete_secret_async(transport: str = 'grpc_asyncio', request_type=service.DeleteSecretRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_secret(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteSecretRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_secret_async_from_dict(): + await test_delete_secret_async(request_type=dict) + + +def test_delete_secret_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DeleteSecretRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_secret), + '__call__') as call: + call.return_value = None + client.delete_secret(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_secret_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DeleteSecretRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_secret), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_secret(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_secret_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_secret), + '__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_secret( + 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_secret_flattened_error(): + client = SecretManagerServiceClient( + 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_secret( + service.DeleteSecretRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_secret_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_secret), + '__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_secret( + 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_secret_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret( + service.DeleteSecretRequest(), + name='name_value', + ) + + +def test_list_secret_versions(transport: str = 'grpc', request_type=service.ListSecretVersionsRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretVersionsResponse( + next_page_token='next_page_token_value', + total_size=1086, + ) + response = client.list_secret_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSecretVersionsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.total_size == 1086 + + +def test_list_secret_versions_from_dict(): + test_list_secret_versions(request_type=dict) + + +def test_list_secret_versions_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 = SecretManagerServiceClient( + 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_secret_versions), + '__call__') as call: + client.list_secret_versions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretVersionsRequest() + + +@pytest.mark.asyncio +async def test_list_secret_versions_async(transport: str = 'grpc_asyncio', request_type=service.ListSecretVersionsRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse( + next_page_token='next_page_token_value', + total_size=1086, + )) + response = await client.list_secret_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListSecretVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSecretVersionsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.total_size == 1086 + + +@pytest.mark.asyncio +async def test_list_secret_versions_async_from_dict(): + await test_list_secret_versions_async(request_type=dict) + + +def test_list_secret_versions_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.ListSecretVersionsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + call.return_value = service.ListSecretVersionsResponse() + client.list_secret_versions(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_secret_versions_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.ListSecretVersionsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse()) + await client.list_secret_versions(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_secret_versions_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretVersionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_secret_versions( + 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_secret_versions_flattened_error(): + client = SecretManagerServiceClient( + 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_secret_versions( + service.ListSecretVersionsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_secret_versions_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListSecretVersionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_secret_versions( + 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_secret_versions_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret_versions( + service.ListSecretVersionsRequest(), + parent='parent_value', + ) + + +def test_list_secret_versions_pager(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + resources.SecretVersion(), + ], + next_page_token='abc', + ), + service.ListSecretVersionsResponse( + versions=[], + next_page_token='def', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + ], + next_page_token='ghi', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_secret_versions(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, resources.SecretVersion) + for i in results) + +def test_list_secret_versions_pages(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + resources.SecretVersion(), + ], + next_page_token='abc', + ), + service.ListSecretVersionsResponse( + versions=[], + next_page_token='def', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + ], + next_page_token='ghi', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + ], + ), + RuntimeError, + ) + pages = list(client.list_secret_versions(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_secret_versions_async_pager(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + resources.SecretVersion(), + ], + next_page_token='abc', + ), + service.ListSecretVersionsResponse( + versions=[], + next_page_token='def', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + ], + next_page_token='ghi', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_secret_versions(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, resources.SecretVersion) + for i in responses) + +@pytest.mark.asyncio +async def test_list_secret_versions_async_pages(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_secret_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + resources.SecretVersion(), + ], + next_page_token='abc', + ), + service.ListSecretVersionsResponse( + versions=[], + next_page_token='def', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + ], + next_page_token='ghi', + ), + service.ListSecretVersionsResponse( + versions=[ + resources.SecretVersion(), + resources.SecretVersion(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_secret_versions(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_secret_version(transport: str = 'grpc', request_type=service.GetSecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + ) + response = client.get_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +def test_get_secret_version_from_dict(): + test_get_secret_version(request_type=dict) + + +def test_get_secret_version_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 = SecretManagerServiceClient( + 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_secret_version), + '__call__') as call: + client.get_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretVersionRequest() + + +@pytest.mark.asyncio +async def test_get_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.GetSecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + )) + response = await client.get_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_secret_version_async_from_dict(): + await test_get_secret_version_async(request_type=dict) + + +def test_get_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.GetSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret_version), + '__call__') as call: + call.return_value = resources.SecretVersion() + client.get_secret_version(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_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.GetSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + await client.get_secret_version(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_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_secret_version( + 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_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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_secret_version( + service.GetSecretVersionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_secret_version( + 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_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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_secret_version( + service.GetSecretVersionRequest(), + name='name_value', + ) + + +def test_access_secret_version(transport: str = 'grpc', request_type=service.AccessSecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.AccessSecretVersionResponse( + name='name_value', + ) + response = client.access_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.AccessSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.AccessSecretVersionResponse) + assert response.name == 'name_value' + + +def test_access_secret_version_from_dict(): + test_access_secret_version(request_type=dict) + + +def test_access_secret_version_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 = SecretManagerServiceClient( + 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.access_secret_version), + '__call__') as call: + client.access_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.AccessSecretVersionRequest() + + +@pytest.mark.asyncio +async def test_access_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.AccessSecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse( + name='name_value', + )) + response = await client.access_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.AccessSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.AccessSecretVersionResponse) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_access_secret_version_async_from_dict(): + await test_access_secret_version_async(request_type=dict) + + +def test_access_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.AccessSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + call.return_value = service.AccessSecretVersionResponse() + client.access_secret_version(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_access_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.AccessSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse()) + await client.access_secret_version(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_access_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.AccessSecretVersionResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.access_secret_version( + 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_access_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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.access_secret_version( + service.AccessSecretVersionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_access_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.access_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.AccessSecretVersionResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.access_secret_version( + 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_access_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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.access_secret_version( + service.AccessSecretVersionRequest(), + name='name_value', + ) + + +def test_disable_secret_version(transport: str = 'grpc', request_type=service.DisableSecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + ) + response = client.disable_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.DisableSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +def test_disable_secret_version_from_dict(): + test_disable_secret_version(request_type=dict) + + +def test_disable_secret_version_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 = SecretManagerServiceClient( + 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.disable_secret_version), + '__call__') as call: + client.disable_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.DisableSecretVersionRequest() + + +@pytest.mark.asyncio +async def test_disable_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.DisableSecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + )) + response = await client.disable_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.DisableSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_disable_secret_version_async_from_dict(): + await test_disable_secret_version_async(request_type=dict) + + +def test_disable_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DisableSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + call.return_value = resources.SecretVersion() + client.disable_secret_version(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_disable_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DisableSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + await client.disable_secret_version(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_disable_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.disable_secret_version( + 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_disable_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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.disable_secret_version( + service.DisableSecretVersionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_disable_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.disable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.disable_secret_version( + 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_disable_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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.disable_secret_version( + service.DisableSecretVersionRequest(), + name='name_value', + ) + + +def test_enable_secret_version(transport: str = 'grpc', request_type=service.EnableSecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + ) + response = client.enable_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.EnableSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +def test_enable_secret_version_from_dict(): + test_enable_secret_version(request_type=dict) + + +def test_enable_secret_version_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 = SecretManagerServiceClient( + 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.enable_secret_version), + '__call__') as call: + client.enable_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.EnableSecretVersionRequest() + + +@pytest.mark.asyncio +async def test_enable_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.EnableSecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + )) + response = await client.enable_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.EnableSecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_enable_secret_version_async_from_dict(): + await test_enable_secret_version_async(request_type=dict) + + +def test_enable_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.EnableSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + call.return_value = resources.SecretVersion() + client.enable_secret_version(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_enable_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.EnableSecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + await client.enable_secret_version(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_enable_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.enable_secret_version( + 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_enable_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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.enable_secret_version( + service.EnableSecretVersionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_enable_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.enable_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.enable_secret_version( + 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_enable_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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.enable_secret_version( + service.EnableSecretVersionRequest(), + name='name_value', + ) + + +def test_destroy_secret_version(transport: str = 'grpc', request_type=service.DestroySecretVersionRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + ) + response = client.destroy_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.DestroySecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +def test_destroy_secret_version_from_dict(): + test_destroy_secret_version(request_type=dict) + + +def test_destroy_secret_version_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 = SecretManagerServiceClient( + 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.destroy_secret_version), + '__call__') as call: + client.destroy_secret_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.DestroySecretVersionRequest() + + +@pytest.mark.asyncio +async def test_destroy_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.DestroySecretVersionRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( + name='name_value', + state=resources.SecretVersion.State.ENABLED, + etag='etag_value', + )) + response = await client.destroy_secret_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.DestroySecretVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.SecretVersion) + assert response.name == 'name_value' + assert response.state == resources.SecretVersion.State.ENABLED + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_destroy_secret_version_async_from_dict(): + await test_destroy_secret_version_async(request_type=dict) + + +def test_destroy_secret_version_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DestroySecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + call.return_value = resources.SecretVersion() + client.destroy_secret_version(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_destroy_secret_version_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = service.DestroySecretVersionRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + await client.destroy_secret_version(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_destroy_secret_version_flattened(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.destroy_secret_version( + 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_destroy_secret_version_flattened_error(): + client = SecretManagerServiceClient( + 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.destroy_secret_version( + service.DestroySecretVersionRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_destroy_secret_version_flattened_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.destroy_secret_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resources.SecretVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.destroy_secret_version( + 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_destroy_secret_version_flattened_error_async(): + client = SecretManagerServiceAsyncClient( + 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.destroy_secret_version( + service.DestroySecretVersionRequest(), + name='name_value', + ) + + +def test_set_iam_policy(transport: str = 'grpc', request_type=iam_policy_pb2.SetIamPolicyRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_set_iam_policy_from_dict(): + test_set_iam_policy(request_type=dict) + + +def test_set_iam_policy_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 = SecretManagerServiceClient( + 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.set_iam_policy), + '__call__') as call: + client.set_iam_policy() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + + +@pytest.mark.asyncio +async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_set_iam_policy_async_from_dict(): + await test_set_iam_policy_async(request_type=dict) + + +def test_set_iam_policy_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_iam_policy_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + +def test_set_iam_policy_from_dict_foreign(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.set_iam_policy(request={ + 'resource': 'resource_value', + 'policy': policy_pb2.Policy(version=774), + } + ) + call.assert_called() + + +def test_get_iam_policy(transport: str = 'grpc', request_type=iam_policy_pb2.GetIamPolicyRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_get_iam_policy_from_dict(): + test_get_iam_policy(request_type=dict) + + +def test_get_iam_policy_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 = SecretManagerServiceClient( + 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_iam_policy), + '__call__') as call: + client.get_iam_policy() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + + +@pytest.mark.asyncio +async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_get_iam_policy_async_from_dict(): + await test_get_iam_policy_async(request_type=dict) + + +def test_get_iam_policy_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_iam_policy_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + +def test_get_iam_policy_from_dict_foreign(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.get_iam_policy(request={ + 'resource': 'resource_value', + 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), + } + ) + call.assert_called() + + +def test_test_iam_permissions(transport: str = 'grpc', request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + ) + response = client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +def test_test_iam_permissions_from_dict(): + test_test_iam_permissions(request_type=dict) + + +def test_test_iam_permissions_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 = SecretManagerServiceClient( + 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.test_iam_permissions), + '__call__') as call: + client.test_iam_permissions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + + +@pytest.mark.asyncio +async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + )) + response = await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_async_from_dict(): + await test_test_iam_permissions_async(request_type=dict) + + +def test_test_iam_permissions_field_headers(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_field_headers_async(): + client = SecretManagerServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) + await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource/value', + ) in kw['metadata'] + +def test_test_iam_permissions_from_dict_foreign(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + response = client.test_iam_permissions(request={ + 'resource': 'resource_value', + 'permissions': ['permissions_value'], + } + ) + call.assert_called() + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SecretManagerServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SecretManagerServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SecretManagerServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SecretManagerServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SecretManagerServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SecretManagerServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SecretManagerServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SecretManagerServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SecretManagerServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SecretManagerServiceGrpcTransport, + transports.SecretManagerServiceGrpcAsyncIOTransport, +]) +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 = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SecretManagerServiceGrpcTransport, + ) + +def test_secret_manager_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SecretManagerServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_secret_manager_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SecretManagerServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_secrets', + 'create_secret', + 'add_secret_version', + 'get_secret', + 'update_secret', + 'delete_secret', + 'list_secret_versions', + 'get_secret_version', + 'access_secret_version', + 'disable_secret_version', + 'enable_secret_version', + 'destroy_secret_version', + 'set_iam_policy', + 'get_iam_policy', + 'test_iam_permissions', + ) + 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_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SecretManagerServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SecretManagerServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SecretManagerServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_secret_manager_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) + SecretManagerServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_secret_manager_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) + SecretManagerServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SecretManagerServiceGrpcTransport, + transports.SecretManagerServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_secret_manager_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SecretManagerServiceGrpcTransport, + transports.SecretManagerServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_secret_manager_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SecretManagerServiceGrpcTransport, grpc_helpers), + (transports.SecretManagerServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_secret_manager_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( + "secretmanager.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="secretmanager.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) +def test_secret_manager_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_secret_manager_service_host_no_port(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='secretmanager.googleapis.com'), + ) + assert client.transport._host == 'secretmanager.googleapis.com:443' + + +def test_secret_manager_service_host_with_port(): + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='secretmanager.googleapis.com:8000'), + ) + assert client.transport._host == 'secretmanager.googleapis.com:8000' + +def test_secret_manager_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SecretManagerServiceGrpcTransport( + 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_secret_manager_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SecretManagerServiceGrpcAsyncIOTransport( + 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.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) +def test_secret_manager_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.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) +def test_secret_manager_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_secret_path(): + project = "squid" + secret = "clam" + expected = "projects/{project}/secrets/{secret}".format(project=project, secret=secret, ) + actual = SecretManagerServiceClient.secret_path(project, secret) + assert expected == actual + + +def test_parse_secret_path(): + expected = { + "project": "whelk", + "secret": "octopus", + } + path = SecretManagerServiceClient.secret_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_secret_path(path) + assert expected == actual + +def test_secret_version_path(): + project = "oyster" + secret = "nudibranch" + secret_version = "cuttlefish" + expected = "projects/{project}/secrets/{secret}/versions/{secret_version}".format(project=project, secret=secret, secret_version=secret_version, ) + actual = SecretManagerServiceClient.secret_version_path(project, secret, secret_version) + assert expected == actual + + +def test_parse_secret_version_path(): + expected = { + "project": "mussel", + "secret": "winkle", + "secret_version": "nautilus", + } + path = SecretManagerServiceClient.secret_version_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_secret_version_path(path) + assert expected == actual + +def test_topic_path(): + project = "scallop" + topic = "abalone" + expected = "projects/{project}/topics/{topic}".format(project=project, topic=topic, ) + actual = SecretManagerServiceClient.topic_path(project, topic) + assert expected == actual + + +def test_parse_topic_path(): + expected = { + "project": "squid", + "topic": "clam", + } + path = SecretManagerServiceClient.topic_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_topic_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SecretManagerServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = SecretManagerServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format(folder=folder, ) + actual = SecretManagerServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = SecretManagerServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SecretManagerServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = SecretManagerServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format(project=project, ) + actual = SecretManagerServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = SecretManagerServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = SecretManagerServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = SecretManagerServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SecretManagerServiceClient.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.SecretManagerServiceTransport, '_prep_wrapped_messages') as prep: + client = SecretManagerServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SecretManagerServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = SecretManagerServiceClient.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 = SecretManagerServiceAsyncClient( + 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 = SecretManagerServiceClient( + 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 = SecretManagerServiceClient( + 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 d67029469ccc655ae0be73f12bdbf7d89f6b277d Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 6 Oct 2021 23:02:24 +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 --- .../secret_manager_service/async_client.py | 6 + .../services/secret_manager_service/client.py | 18 +- .../secret_manager_service/transports/base.py | 9 + .../secret_manager_service/transports/grpc.py | 3 + .../transports/grpc_asyncio.py | 3 + .../cloud/secretmanager_v1/types/resources.py | 2 + owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 -- owl-bot-staging/v1/docs/index.rst | 7 - .../secret_manager_service.rst | 10 - .../v1/docs/secretmanager_v1/services.rst | 6 - .../v1/docs/secretmanager_v1/types.rst | 7 - .../v1/google/cloud/secretmanager/__init__.py | 71 - .../v1/google/cloud/secretmanager/py.typed | 2 - .../google/cloud/secretmanager_v1/__init__.py | 72 - .../secretmanager_v1/gapic_metadata.json | 173 - .../v1/google/cloud/secretmanager_v1/py.typed | 2 - .../secretmanager_v1/services/__init__.py | 15 - .../secret_manager_service/__init__.py | 22 - .../secret_manager_service/async_client.py | 1526 ------ .../services/secret_manager_service/client.py | 1731 ------ .../services/secret_manager_service/pagers.py | 263 - .../transports/__init__.py | 33 - .../secret_manager_service/transports/base.py | 384 -- .../secret_manager_service/transports/grpc.py | 685 --- .../transports/grpc_asyncio.py | 690 --- .../cloud/secretmanager_v1/types/__init__.py | 70 - .../cloud/secretmanager_v1/types/resources.py | 558 -- .../cloud/secretmanager_v1/types/service.py | 488 -- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../fixup_secretmanager_v1_keywords.py | 190 - 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 - .../unit/gapic/secretmanager_v1/__init__.py | 16 - .../test_secret_manager_service.py | 4780 ----------------- .../test_secret_manager_service.py | 50 + 41 files changed, 87 insertions(+), 12486 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/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst delete mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/secretmanager_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py delete mode 100644 owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_secretmanager_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/secretmanager_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py diff --git a/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py b/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py index 728b9d3..7110295 100644 --- a/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py +++ b/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py @@ -1460,6 +1460,12 @@ async def test_iam_permissions( # 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/secretmanager_v1/services/secret_manager_service/client.py b/google/cloud/secretmanager_v1/services/secret_manager_service/client.py index a6de513..a46c419 100644 --- a/google/cloud/secretmanager_v1/services/secret_manager_service/client.py +++ b/google/cloud/secretmanager_v1/services/secret_manager_service/client.py @@ -383,10 +383,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 list_secrets( @@ -1655,6 +1652,19 @@ def test_iam_permissions( # 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/secretmanager_v1/services/secret_manager_service/transports/base.py b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py index 7ec7430..c5ed0da 100644 --- a/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py +++ b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py @@ -227,6 +227,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 list_secrets( self, diff --git a/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py index 627cb53..64fbc55 100644 --- a/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py +++ b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py @@ -685,5 +685,8 @@ def test_iam_permissions( ) return self._stubs["test_iam_permissions"] + def close(self): + self.grpc_channel.close() + __all__ = ("SecretManagerServiceGrpcTransport",) diff --git a/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py index 64905b7..9907665 100644 --- a/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py +++ b/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py @@ -704,5 +704,8 @@ def test_iam_permissions( ) return self._stubs["test_iam_permissions"] + def close(self): + return self.grpc_channel.close() + __all__ = ("SecretManagerServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/secretmanager_v1/types/resources.py b/google/cloud/secretmanager_v1/types/resources.py index d445501..a521d90 100644 --- a/google/cloud/secretmanager_v1/types/resources.py +++ b/google/cloud/secretmanager_v1/types/resources.py @@ -112,6 +112,7 @@ class Secret(proto.Message): class SecretVersion(proto.Message): r"""A secret version resource in the Secret Manager API. + Attributes: name (str): Output only. The resource name of the @@ -377,6 +378,7 @@ class ReplicaStatus(proto.Message): class CustomerManagedEncryptionStatus(proto.Message): r"""Describes the status of customer-managed encryption. + Attributes: kms_key_version_name (str): Required. The resource name of the Cloud KMS diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index 2287362..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/secretmanager/__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 3f781d4..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/secretmanager *.py -recursive-include google/cloud/secretmanager_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 358776d..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Secretmanager 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 Secretmanager API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 3d2ecfc..0000000 --- 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-secretmanager 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-secretmanager" -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-secretmanager-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-secretmanager.tex", - u"google-cloud-secretmanager 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-secretmanager", - u"Google Cloud Secretmanager 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-secretmanager", - u"google-cloud-secretmanager Documentation", - author, - "google-cloud-secretmanager", - "GAPIC library for Google Cloud Secretmanager 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 9072a8c..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - secretmanager_v1/services - secretmanager_v1/types diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst b/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst deleted file mode 100644 index 2aa590e..0000000 --- a/owl-bot-staging/v1/docs/secretmanager_v1/secret_manager_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -SecretManagerService --------------------------------------- - -.. automodule:: google.cloud.secretmanager_v1.services.secret_manager_service - :members: - :inherited-members: - -.. automodule:: google.cloud.secretmanager_v1.services.secret_manager_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/services.rst b/owl-bot-staging/v1/docs/secretmanager_v1/services.rst deleted file mode 100644 index aac8f75..0000000 --- a/owl-bot-staging/v1/docs/secretmanager_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Secretmanager v1 API -============================================== -.. toctree:: - :maxdepth: 2 - - secret_manager_service diff --git a/owl-bot-staging/v1/docs/secretmanager_v1/types.rst b/owl-bot-staging/v1/docs/secretmanager_v1/types.rst deleted file mode 100644 index a3cb4ce..0000000 --- a/owl-bot-staging/v1/docs/secretmanager_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Secretmanager v1 API -=========================================== - -.. automodule:: google.cloud.secretmanager_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py deleted file mode 100644 index 5e40a78..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager/__init__.py +++ /dev/null @@ -1,71 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.cloud.secretmanager_v1.services.secret_manager_service.client import SecretManagerServiceClient -from google.cloud.secretmanager_v1.services.secret_manager_service.async_client import SecretManagerServiceAsyncClient - -from google.cloud.secretmanager_v1.types.resources import CustomerManagedEncryption -from google.cloud.secretmanager_v1.types.resources import CustomerManagedEncryptionStatus -from google.cloud.secretmanager_v1.types.resources import Replication -from google.cloud.secretmanager_v1.types.resources import ReplicationStatus -from google.cloud.secretmanager_v1.types.resources import Rotation -from google.cloud.secretmanager_v1.types.resources import Secret -from google.cloud.secretmanager_v1.types.resources import SecretPayload -from google.cloud.secretmanager_v1.types.resources import SecretVersion -from google.cloud.secretmanager_v1.types.resources import Topic -from google.cloud.secretmanager_v1.types.service import AccessSecretVersionRequest -from google.cloud.secretmanager_v1.types.service import AccessSecretVersionResponse -from google.cloud.secretmanager_v1.types.service import AddSecretVersionRequest -from google.cloud.secretmanager_v1.types.service import CreateSecretRequest -from google.cloud.secretmanager_v1.types.service import DeleteSecretRequest -from google.cloud.secretmanager_v1.types.service import DestroySecretVersionRequest -from google.cloud.secretmanager_v1.types.service import DisableSecretVersionRequest -from google.cloud.secretmanager_v1.types.service import EnableSecretVersionRequest -from google.cloud.secretmanager_v1.types.service import GetSecretRequest -from google.cloud.secretmanager_v1.types.service import GetSecretVersionRequest -from google.cloud.secretmanager_v1.types.service import ListSecretsRequest -from google.cloud.secretmanager_v1.types.service import ListSecretsResponse -from google.cloud.secretmanager_v1.types.service import ListSecretVersionsRequest -from google.cloud.secretmanager_v1.types.service import ListSecretVersionsResponse -from google.cloud.secretmanager_v1.types.service import UpdateSecretRequest - -__all__ = ('SecretManagerServiceClient', - 'SecretManagerServiceAsyncClient', - 'CustomerManagedEncryption', - 'CustomerManagedEncryptionStatus', - 'Replication', - 'ReplicationStatus', - 'Rotation', - 'Secret', - 'SecretPayload', - 'SecretVersion', - 'Topic', - 'AccessSecretVersionRequest', - 'AccessSecretVersionResponse', - 'AddSecretVersionRequest', - 'CreateSecretRequest', - 'DeleteSecretRequest', - 'DestroySecretVersionRequest', - 'DisableSecretVersionRequest', - 'EnableSecretVersionRequest', - 'GetSecretRequest', - 'GetSecretVersionRequest', - 'ListSecretsRequest', - 'ListSecretsResponse', - 'ListSecretVersionsRequest', - 'ListSecretVersionsResponse', - 'UpdateSecretRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager/py.typed b/owl-bot-staging/v1/google/cloud/secretmanager/py.typed deleted file mode 100644 index 188cc03..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-secretmanager package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py deleted file mode 100644 index 102f4d0..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/__init__.py +++ /dev/null @@ -1,72 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .services.secret_manager_service import SecretManagerServiceClient -from .services.secret_manager_service import SecretManagerServiceAsyncClient - -from .types.resources import CustomerManagedEncryption -from .types.resources import CustomerManagedEncryptionStatus -from .types.resources import Replication -from .types.resources import ReplicationStatus -from .types.resources import Rotation -from .types.resources import Secret -from .types.resources import SecretPayload -from .types.resources import SecretVersion -from .types.resources import Topic -from .types.service import AccessSecretVersionRequest -from .types.service import AccessSecretVersionResponse -from .types.service import AddSecretVersionRequest -from .types.service import CreateSecretRequest -from .types.service import DeleteSecretRequest -from .types.service import DestroySecretVersionRequest -from .types.service import DisableSecretVersionRequest -from .types.service import EnableSecretVersionRequest -from .types.service import GetSecretRequest -from .types.service import GetSecretVersionRequest -from .types.service import ListSecretsRequest -from .types.service import ListSecretsResponse -from .types.service import ListSecretVersionsRequest -from .types.service import ListSecretVersionsResponse -from .types.service import UpdateSecretRequest - -__all__ = ( - 'SecretManagerServiceAsyncClient', -'AccessSecretVersionRequest', -'AccessSecretVersionResponse', -'AddSecretVersionRequest', -'CreateSecretRequest', -'CustomerManagedEncryption', -'CustomerManagedEncryptionStatus', -'DeleteSecretRequest', -'DestroySecretVersionRequest', -'DisableSecretVersionRequest', -'EnableSecretVersionRequest', -'GetSecretRequest', -'GetSecretVersionRequest', -'ListSecretVersionsRequest', -'ListSecretVersionsResponse', -'ListSecretsRequest', -'ListSecretsResponse', -'Replication', -'ReplicationStatus', -'Rotation', -'Secret', -'SecretManagerServiceClient', -'SecretPayload', -'SecretVersion', -'Topic', -'UpdateSecretRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json deleted file mode 100644 index 4c427b1..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/gapic_metadata.json +++ /dev/null @@ -1,173 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.secretmanager_v1", - "protoPackage": "google.cloud.secretmanager.v1", - "schema": "1.0", - "services": { - "SecretManagerService": { - "clients": { - "grpc": { - "libraryClient": "SecretManagerServiceClient", - "rpcs": { - "AccessSecretVersion": { - "methods": [ - "access_secret_version" - ] - }, - "AddSecretVersion": { - "methods": [ - "add_secret_version" - ] - }, - "CreateSecret": { - "methods": [ - "create_secret" - ] - }, - "DeleteSecret": { - "methods": [ - "delete_secret" - ] - }, - "DestroySecretVersion": { - "methods": [ - "destroy_secret_version" - ] - }, - "DisableSecretVersion": { - "methods": [ - "disable_secret_version" - ] - }, - "EnableSecretVersion": { - "methods": [ - "enable_secret_version" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetSecret": { - "methods": [ - "get_secret" - ] - }, - "GetSecretVersion": { - "methods": [ - "get_secret_version" - ] - }, - "ListSecretVersions": { - "methods": [ - "list_secret_versions" - ] - }, - "ListSecrets": { - "methods": [ - "list_secrets" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateSecret": { - "methods": [ - "update_secret" - ] - } - } - }, - "grpc-async": { - "libraryClient": "SecretManagerServiceAsyncClient", - "rpcs": { - "AccessSecretVersion": { - "methods": [ - "access_secret_version" - ] - }, - "AddSecretVersion": { - "methods": [ - "add_secret_version" - ] - }, - "CreateSecret": { - "methods": [ - "create_secret" - ] - }, - "DeleteSecret": { - "methods": [ - "delete_secret" - ] - }, - "DestroySecretVersion": { - "methods": [ - "destroy_secret_version" - ] - }, - "DisableSecretVersion": { - "methods": [ - "disable_secret_version" - ] - }, - "EnableSecretVersion": { - "methods": [ - "enable_secret_version" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetSecret": { - "methods": [ - "get_secret" - ] - }, - "GetSecretVersion": { - "methods": [ - "get_secret_version" - ] - }, - "ListSecretVersions": { - "methods": [ - "list_secret_versions" - ] - }, - "ListSecrets": { - "methods": [ - "list_secrets" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateSecret": { - "methods": [ - "update_secret" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed b/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed deleted file mode 100644 index 188cc03..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-secretmanager package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_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/secretmanager_v1/services/secret_manager_service/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/__init__.py deleted file mode 100644 index 8dc1ffe..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_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 SecretManagerServiceClient -from .async_client import SecretManagerServiceAsyncClient - -__all__ = ( - 'SecretManagerServiceClient', - 'SecretManagerServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py deleted file mode 100644 index 03d588b..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/async_client.py +++ /dev/null @@ -1,1526 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.secretmanager_v1.services.secret_manager_service import pagers -from google.cloud.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport -from .client import SecretManagerServiceClient - - -class SecretManagerServiceAsyncClient: - """Secret Manager Service - - Manages secrets and operations using those secrets. Implements a - REST model with the following objects: - - - [Secret][google.cloud.secretmanager.v1.Secret] - - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - """ - - _client: SecretManagerServiceClient - - DEFAULT_ENDPOINT = SecretManagerServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = SecretManagerServiceClient.DEFAULT_MTLS_ENDPOINT - - secret_path = staticmethod(SecretManagerServiceClient.secret_path) - parse_secret_path = staticmethod(SecretManagerServiceClient.parse_secret_path) - secret_version_path = staticmethod(SecretManagerServiceClient.secret_version_path) - parse_secret_version_path = staticmethod(SecretManagerServiceClient.parse_secret_version_path) - topic_path = staticmethod(SecretManagerServiceClient.topic_path) - parse_topic_path = staticmethod(SecretManagerServiceClient.parse_topic_path) - common_billing_account_path = staticmethod(SecretManagerServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(SecretManagerServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(SecretManagerServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(SecretManagerServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(SecretManagerServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(SecretManagerServiceClient.parse_common_organization_path) - common_project_path = staticmethod(SecretManagerServiceClient.common_project_path) - parse_common_project_path = staticmethod(SecretManagerServiceClient.parse_common_project_path) - common_location_path = staticmethod(SecretManagerServiceClient.common_location_path) - parse_common_location_path = staticmethod(SecretManagerServiceClient.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: - SecretManagerServiceAsyncClient: The constructed client. - """ - return SecretManagerServiceClient.from_service_account_info.__func__(SecretManagerServiceAsyncClient, 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: - SecretManagerServiceAsyncClient: The constructed client. - """ - return SecretManagerServiceClient.from_service_account_file.__func__(SecretManagerServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> SecretManagerServiceTransport: - """Returns the transport used by the client instance. - - Returns: - SecretManagerServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(SecretManagerServiceClient).get_transport_class, type(SecretManagerServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, SecretManagerServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the secret manager 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, ~.SecretManagerServiceTransport]): 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 = SecretManagerServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def list_secrets(self, - request: service.ListSecretsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListSecretsAsyncPager: - r"""Lists [Secrets][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.ListSecretsRequest`): - The request object. Request message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - parent (:class:`str`): - Required. The resource name of the project associated - with the - [Secrets][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*``. - - 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretsAsyncPager: - Response message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - - 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 = service.ListSecretsRequest(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_secrets, - 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.ListSecretsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_secret(self, - request: service.CreateSecretRequest = None, - *, - parent: str = None, - secret_id: str = None, - secret: resources.Secret = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Creates a new [Secret][google.cloud.secretmanager.v1.Secret] - containing no - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.CreateSecretRequest`): - The request object. Request message for - [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. - parent (:class:`str`): - Required. The resource name of the project to associate - with the [Secret][google.cloud.secretmanager.v1.Secret], - in the format ``projects/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - secret_id (:class:`str`): - Required. This must be unique within the project. - - A secret ID is a string with a maximum length of 255 - characters and can contain uppercase and lowercase - letters, numerals, and the hyphen (``-``) and underscore - (``_``) characters. - - This corresponds to the ``secret_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - secret (:class:`google.cloud.secretmanager_v1.types.Secret`): - Required. A - [Secret][google.cloud.secretmanager.v1.Secret] with - initial field values. - - This corresponds to the ``secret`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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, secret_id, secret]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.CreateSecretRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if secret_id is not None: - request.secret_id = secret_id - if secret is not None: - request.secret = secret - - # 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_secret, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def add_secret_version(self, - request: service.AddSecretVersionRequest = None, - *, - parent: str = None, - payload: resources.SecretPayload = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Creates a new - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - containing secret data and attaches it to an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.AddSecretVersionRequest`): - The request object. Request message for - [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. - parent (:class:`str`): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to - associate with the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - payload (:class:`google.cloud.secretmanager_v1.types.SecretPayload`): - Required. The secret payload of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - This corresponds to the ``payload`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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, payload]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.AddSecretVersionRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if payload is not None: - request.payload = payload - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.add_secret_version, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_secret(self, - request: service.GetSecretRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Gets metadata for a given - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.GetSecretRequest`): - The request object. Request message for - [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. - name (:class:`str`): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*/secrets/*``. - - 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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 = service.GetSecretRequest(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_secret, - 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_secret(self, - request: service.UpdateSecretRequest = None, - *, - secret: resources.Secret = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Updates metadata of an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.UpdateSecretRequest`): - The request object. Request message for - [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. - secret (:class:`google.cloud.secretmanager_v1.types.Secret`): - Required. [Secret][google.cloud.secretmanager.v1.Secret] - with updated field values. - - This corresponds to the ``secret`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. Specifies the 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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([secret, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.UpdateSecretRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if secret is not None: - request.secret = secret - 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_secret, - 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(( - ("secret.name", request.secret.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_secret(self, - request: service.DeleteSecretRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.DeleteSecretRequest`): - The request object. Request message for - [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. - name (:class:`str`): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to delete - in the format ``projects/*/secrets/*``. - - 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 = service.DeleteSecretRequest(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_secret, - 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 list_secret_versions(self, - request: service.ListSecretVersionsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListSecretVersionsAsyncPager: - r"""Lists - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - This call does not return secret data. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.ListSecretVersionsRequest`): - The request object. Request message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - parent (:class:`str`): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] - associated with the - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - to list, in the format ``projects/*/secrets/*``. - - 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager: - Response message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - - 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 = service.ListSecretVersionsRequest(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_secret_versions, - 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.ListSecretVersionsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_secret_version(self, - request: service.GetSecretVersionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Gets metadata for a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.GetSecretVersionRequest`): - The request object. Request message for - [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. - name (:class:`str`): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to - the most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 = service.GetSecretVersionRequest(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_secret_version, - 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 access_secret_version(self, - request: service.AccessSecretVersionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.AccessSecretVersionResponse: - r"""Accesses a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - This call returns the secret data. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.AccessSecretVersionRequest`): - The request object. Request message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - name (:class:`str`): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to - the most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - 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.secretmanager_v1.types.AccessSecretVersionResponse: - Response message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - - """ - # 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 = service.AccessSecretVersionRequest(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.access_secret_version, - default_retry=retries.Retry( -initial=2.0,maximum=60.0,multiplier=2.0, predicate=retries.if_exception_type( - core_exceptions.ResourceExhausted, - 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 disable_secret_version(self, - request: service.DisableSecretVersionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Disables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.DisableSecretVersionRequest`): - The request object. Request message for - [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. - name (:class:`str`): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to disable in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 = service.DisableSecretVersionRequest(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.disable_secret_version, - 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 enable_secret_version(self, - request: service.EnableSecretVersionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Enables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.EnableSecretVersionRequest`): - The request object. Request message for - [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. - name (:class:`str`): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to enable in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 = service.EnableSecretVersionRequest(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.enable_secret_version, - 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 destroy_secret_version(self, - request: service.DestroySecretVersionRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Destroys a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] - and irrevocably destroys the secret data. - - Args: - request (:class:`google.cloud.secretmanager_v1.types.DestroySecretVersionRequest`): - The request object. Request message for - [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. - name (:class:`str`): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to destroy in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 = service.DestroySecretVersionRequest(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.destroy_secret_version, - 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 set_iam_policy(self, - request: iam_policy_pb2.SetIamPolicyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Sets the access control policy on the specified secret. Replaces - any existing policy. - - Permissions on - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - are enforced according to the policy set on the associated - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (:class:`google.iam.v1.iam_policy_pb2.SetIamPolicyRequest`): - The request object. Request message for `SetIamPolicy` - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. - - A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ] - - } - - **YAML Example** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') - - For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). - - """ - # Create or coerce a protobuf request object. - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.SetIamPolicyRequest(**request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.set_iam_policy, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_iam_policy(self, - request: iam_policy_pb2.GetIamPolicyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a secret. - Returns empty policy if the secret exists and does not - have a policy set. - - Args: - request (:class:`google.iam.v1.iam_policy_pb2.GetIamPolicyRequest`): - The request object. Request message for `GetIamPolicy` - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. - - A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ] - - } - - **YAML Example** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') - - For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). - - """ - # Create or coerce a protobuf request object. - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.GetIamPolicyRequest(**request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_iam_policy, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def test_iam_permissions(self, - request: iam_policy_pb2.TestIamPermissionsRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Returns permissions that a caller has for the specified secret. - If the secret does not exist, this call returns an empty set of - permissions, not a NOT_FOUND error. - - Note: This operation is designed to be used for building - permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without - warning. - - Args: - request (:class:`google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest`): - The request object. Request message for - `TestIamPermissions` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions method. - """ - # Create or coerce a protobuf request object. - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.TestIamPermissionsRequest(**request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.test_iam_permissions, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - 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-secretmanager", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SecretManagerServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py deleted file mode 100644 index cbee61b..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/client.py +++ /dev/null @@ -1,1731 +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 - -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.secretmanager_v1.services.secret_manager_service import pagers -from google.cloud.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import SecretManagerServiceGrpcTransport -from .transports.grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport - - -class SecretManagerServiceClientMeta(type): - """Metaclass for the SecretManagerService 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[SecretManagerServiceTransport]] - _transport_registry["grpc"] = SecretManagerServiceGrpcTransport - _transport_registry["grpc_asyncio"] = SecretManagerServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[SecretManagerServiceTransport]: - """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 SecretManagerServiceClient(metaclass=SecretManagerServiceClientMeta): - """Secret Manager Service - - Manages secrets and operations using those secrets. Implements a - REST model with the following objects: - - - [Secret][google.cloud.secretmanager.v1.Secret] - - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - """ - - @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 = "secretmanager.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: - SecretManagerServiceClient: 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: - SecretManagerServiceClient: 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) -> SecretManagerServiceTransport: - """Returns the transport used by the client instance. - - Returns: - SecretManagerServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def secret_path(project: str,secret: str,) -> str: - """Returns a fully-qualified secret string.""" - return "projects/{project}/secrets/{secret}".format(project=project, secret=secret, ) - - @staticmethod - def parse_secret_path(path: str) -> Dict[str,str]: - """Parses a secret path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/secrets/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def secret_version_path(project: str,secret: str,secret_version: str,) -> str: - """Returns a fully-qualified secret_version string.""" - return "projects/{project}/secrets/{secret}/versions/{secret_version}".format(project=project, secret=secret, secret_version=secret_version, ) - - @staticmethod - def parse_secret_version_path(path: str) -> Dict[str,str]: - """Parses a secret_version path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/secrets/(?P.+?)/versions/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def topic_path(project: str,topic: str,) -> str: - """Returns a fully-qualified topic string.""" - return "projects/{project}/topics/{topic}".format(project=project, topic=topic, ) - - @staticmethod - def parse_topic_path(path: str) -> Dict[str,str]: - """Parses a topic path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/topics/(?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, SecretManagerServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the secret manager 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, SecretManagerServiceTransport]): 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, SecretManagerServiceTransport): - # transport is a SecretManagerServiceTransport 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 list_secrets(self, - request: Union[service.ListSecretsRequest, dict] = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListSecretsPager: - r"""Lists [Secrets][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.ListSecretsRequest, dict]): - The request object. Request message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - parent (str): - Required. The resource name of the project associated - with the - [Secrets][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*``. - - 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretsPager: - Response message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - - 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 service.ListSecretsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.ListSecretsRequest): - request = service.ListSecretsRequest(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_secrets] - - # 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.ListSecretsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_secret(self, - request: Union[service.CreateSecretRequest, dict] = None, - *, - parent: str = None, - secret_id: str = None, - secret: resources.Secret = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Creates a new [Secret][google.cloud.secretmanager.v1.Secret] - containing no - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.CreateSecretRequest, dict]): - The request object. Request message for - [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. - parent (str): - Required. The resource name of the project to associate - with the [Secret][google.cloud.secretmanager.v1.Secret], - in the format ``projects/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - secret_id (str): - Required. This must be unique within the project. - - A secret ID is a string with a maximum length of 255 - characters and can contain uppercase and lowercase - letters, numerals, and the hyphen (``-``) and underscore - (``_``) characters. - - This corresponds to the ``secret_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - secret (google.cloud.secretmanager_v1.types.Secret): - Required. A - [Secret][google.cloud.secretmanager.v1.Secret] with - initial field values. - - This corresponds to the ``secret`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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, secret_id, secret]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.CreateSecretRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.CreateSecretRequest): - request = service.CreateSecretRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if secret_id is not None: - request.secret_id = secret_id - if secret is not None: - request.secret = secret - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_secret] - - # 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 add_secret_version(self, - request: Union[service.AddSecretVersionRequest, dict] = None, - *, - parent: str = None, - payload: resources.SecretPayload = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Creates a new - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - containing secret data and attaches it to an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.AddSecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. - parent (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to - associate with the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - payload (google.cloud.secretmanager_v1.types.SecretPayload): - Required. The secret payload of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - This corresponds to the ``payload`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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, payload]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.AddSecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.AddSecretVersionRequest): - request = service.AddSecretVersionRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if payload is not None: - request.payload = payload - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.add_secret_version] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_secret(self, - request: Union[service.GetSecretRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Gets metadata for a given - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.GetSecretRequest, dict]): - The request object. Request message for - [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. - name (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*/secrets/*``. - - 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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 service.GetSecretRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.GetSecretRequest): - request = service.GetSecretRequest(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_secret] - - # 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_secret(self, - request: Union[service.UpdateSecretRequest, dict] = None, - *, - secret: resources.Secret = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.Secret: - r"""Updates metadata of an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.UpdateSecretRequest, dict]): - The request object. Request message for - [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. - secret (google.cloud.secretmanager_v1.types.Secret): - Required. [Secret][google.cloud.secretmanager.v1.Secret] - with updated field values. - - This corresponds to the ``secret`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. Specifies the 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.secretmanager_v1.types.Secret: - A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can - be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is - made up of zero or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - that represent the secret data. - - """ - # 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([secret, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.UpdateSecretRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.UpdateSecretRequest): - request = service.UpdateSecretRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if secret is not None: - request.secret = secret - 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_secret] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("secret.name", request.secret.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_secret(self, - request: Union[service.DeleteSecretRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.DeleteSecretRequest, dict]): - The request object. Request message for - [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. - name (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to delete - in the format ``projects/*/secrets/*``. - - 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 service.DeleteSecretRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.DeleteSecretRequest): - request = service.DeleteSecretRequest(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_secret] - - # 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 list_secret_versions(self, - request: Union[service.ListSecretVersionsRequest, dict] = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListSecretVersionsPager: - r"""Lists - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - This call does not return secret data. - - Args: - request (Union[google.cloud.secretmanager_v1.types.ListSecretVersionsRequest, dict]): - The request object. Request message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - parent (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] - associated with the - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - to list, in the format ``projects/*/secrets/*``. - - 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.secretmanager_v1.services.secret_manager_service.pagers.ListSecretVersionsPager: - Response message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - - 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 service.ListSecretVersionsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.ListSecretVersionsRequest): - request = service.ListSecretVersionsRequest(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_secret_versions] - - # 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.ListSecretVersionsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_secret_version(self, - request: Union[service.GetSecretVersionRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Gets metadata for a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.GetSecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to - the most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 service.GetSecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.GetSecretVersionRequest): - request = service.GetSecretVersionRequest(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_secret_version] - - # 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 access_secret_version(self, - request: Union[service.AccessSecretVersionRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.AccessSecretVersionResponse: - r"""Accesses a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - This call returns the secret data. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.AccessSecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to - the most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - 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.secretmanager_v1.types.AccessSecretVersionResponse: - Response message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - - """ - # 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 service.AccessSecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.AccessSecretVersionRequest): - request = service.AccessSecretVersionRequest(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.access_secret_version] - - # 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 disable_secret_version(self, - request: Union[service.DisableSecretVersionRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Disables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.DisableSecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to disable in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 service.DisableSecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.DisableSecretVersionRequest): - request = service.DisableSecretVersionRequest(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.disable_secret_version] - - # 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 enable_secret_version(self, - request: Union[service.EnableSecretVersionRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Enables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. - - Args: - request (Union[google.cloud.secretmanager_v1.types.EnableSecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to enable in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 service.EnableSecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.EnableSecretVersionRequest): - request = service.EnableSecretVersionRequest(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.enable_secret_version] - - # 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 destroy_secret_version(self, - request: Union[service.DestroySecretVersionRequest, dict] = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resources.SecretVersion: - r"""Destroys a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] - and irrevocably destroys the secret data. - - Args: - request (Union[google.cloud.secretmanager_v1.types.DestroySecretVersionRequest, dict]): - The request object. Request message for - [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to destroy in the format - ``projects/*/secrets/*/versions/*``. - - 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.secretmanager_v1.types.SecretVersion: - A secret version resource in the - Secret Manager API. - - """ - # 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 service.DestroySecretVersionRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.DestroySecretVersionRequest): - request = service.DestroySecretVersionRequest(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.destroy_secret_version] - - # 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 set_iam_policy(self, - request: Union[iam_policy_pb2.SetIamPolicyRequest, dict] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Sets the access control policy on the specified secret. Replaces - any existing policy. - - Permissions on - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - are enforced according to the policy set on the associated - [Secret][google.cloud.secretmanager.v1.Secret]. - - Args: - request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): - The request object. Request message for `SetIamPolicy` - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. - - A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ] - - } - - **YAML Example** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') - - For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). - - """ - # Create or coerce a protobuf request object. - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.SetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.SetIamPolicyRequest() - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_iam_policy(self, - request: Union[iam_policy_pb2.GetIamPolicyRequest, dict] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a secret. - Returns empty policy if the secret exists and does not - have a policy set. - - Args: - request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): - The request object. Request message for `GetIamPolicy` - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. - - A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ] - - } - - **YAML Example** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') - - For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). - - """ - # Create or coerce a protobuf request object. - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.GetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.GetIamPolicyRequest() - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def test_iam_permissions(self, - request: Union[iam_policy_pb2.TestIamPermissionsRequest, dict] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Returns permissions that a caller has for the specified secret. - If the secret does not exist, this call returns an empty set of - permissions, not a NOT_FOUND error. - - Note: This operation is designed to be used for building - permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without - warning. - - Args: - request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): - The request object. Request message for - `TestIamPermissions` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions method. - """ - # Create or coerce a protobuf request object. - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.TestIamPermissionsRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.TestIamPermissionsRequest() - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - 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-secretmanager", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SecretManagerServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py deleted file mode 100644 index d0266e9..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/pagers.py +++ /dev/null @@ -1,263 +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.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service - - -class ListSecretsPager: - """A pager for iterating through ``list_secrets`` requests. - - This class thinly wraps an initial - :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``secrets`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListSecrets`` requests and continue to iterate - through the ``secrets`` field on the - corresponding responses. - - All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., service.ListSecretsResponse], - request: service.ListSecretsRequest, - response: service.ListSecretsResponse, - *, - 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.secretmanager_v1.types.ListSecretsRequest): - The initial request object. - response (google.cloud.secretmanager_v1.types.ListSecretsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = service.ListSecretsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[service.ListSecretsResponse]: - 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[resources.Secret]: - for page in self.pages: - yield from page.secrets - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListSecretsAsyncPager: - """A pager for iterating through ``list_secrets`` requests. - - This class thinly wraps an initial - :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``secrets`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListSecrets`` requests and continue to iterate - through the ``secrets`` field on the - corresponding responses. - - All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[service.ListSecretsResponse]], - request: service.ListSecretsRequest, - response: service.ListSecretsResponse, - *, - 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.secretmanager_v1.types.ListSecretsRequest): - The initial request object. - response (google.cloud.secretmanager_v1.types.ListSecretsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = service.ListSecretsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[service.ListSecretsResponse]: - 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[resources.Secret]: - async def async_generator(): - async for page in self.pages: - for response in page.secrets: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListSecretVersionsPager: - """A pager for iterating through ``list_secret_versions`` requests. - - This class thinly wraps an initial - :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``versions`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListSecretVersions`` requests and continue to iterate - through the ``versions`` field on the - corresponding responses. - - All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., service.ListSecretVersionsResponse], - request: service.ListSecretVersionsRequest, - response: service.ListSecretVersionsResponse, - *, - 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.secretmanager_v1.types.ListSecretVersionsRequest): - The initial request object. - response (google.cloud.secretmanager_v1.types.ListSecretVersionsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = service.ListSecretVersionsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[service.ListSecretVersionsResponse]: - 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[resources.SecretVersion]: - for page in self.pages: - yield from page.versions - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListSecretVersionsAsyncPager: - """A pager for iterating through ``list_secret_versions`` requests. - - This class thinly wraps an initial - :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``versions`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListSecretVersions`` requests and continue to iterate - through the ``versions`` field on the - corresponding responses. - - All the usual :class:`google.cloud.secretmanager_v1.types.ListSecretVersionsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[service.ListSecretVersionsResponse]], - request: service.ListSecretVersionsRequest, - response: service.ListSecretVersionsResponse, - *, - 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.secretmanager_v1.types.ListSecretVersionsRequest): - The initial request object. - response (google.cloud.secretmanager_v1.types.ListSecretVersionsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = service.ListSecretVersionsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[service.ListSecretVersionsResponse]: - 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[resources.SecretVersion]: - async def async_generator(): - async for page in self.pages: - for response in page.versions: - 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/secretmanager_v1/services/secret_manager_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/__init__.py deleted file mode 100644 index 1004413..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_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 SecretManagerServiceTransport -from .grpc import SecretManagerServiceGrpcTransport -from .grpc_asyncio import SecretManagerServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[SecretManagerServiceTransport]] -_transport_registry['grpc'] = SecretManagerServiceGrpcTransport -_transport_registry['grpc_asyncio'] = SecretManagerServiceGrpcAsyncIOTransport - -__all__ = ( - 'SecretManagerServiceTransport', - 'SecretManagerServiceGrpcTransport', - 'SecretManagerServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py deleted file mode 100644 index e38df13..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/base.py +++ /dev/null @@ -1,384 +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.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -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-secretmanager', - ).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 SecretManagerServiceTransport(abc.ABC): - """Abstract transport class for SecretManagerService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'secretmanager.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.list_secrets: gapic_v1.method.wrap_method( - self.list_secrets, - default_timeout=60.0, - client_info=client_info, - ), - self.create_secret: gapic_v1.method.wrap_method( - self.create_secret, - default_timeout=60.0, - client_info=client_info, - ), - self.add_secret_version: gapic_v1.method.wrap_method( - self.add_secret_version, - default_timeout=60.0, - client_info=client_info, - ), - self.get_secret: gapic_v1.method.wrap_method( - self.get_secret, - default_timeout=60.0, - client_info=client_info, - ), - self.update_secret: gapic_v1.method.wrap_method( - self.update_secret, - default_timeout=60.0, - client_info=client_info, - ), - self.delete_secret: gapic_v1.method.wrap_method( - self.delete_secret, - default_timeout=60.0, - client_info=client_info, - ), - self.list_secret_versions: gapic_v1.method.wrap_method( - self.list_secret_versions, - default_timeout=60.0, - client_info=client_info, - ), - self.get_secret_version: gapic_v1.method.wrap_method( - self.get_secret_version, - default_timeout=60.0, - client_info=client_info, - ), - self.access_secret_version: gapic_v1.method.wrap_method( - self.access_secret_version, - default_retry=retries.Retry( -initial=2.0,maximum=60.0,multiplier=2.0, predicate=retries.if_exception_type( - core_exceptions.ResourceExhausted, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.disable_secret_version: gapic_v1.method.wrap_method( - self.disable_secret_version, - default_timeout=60.0, - client_info=client_info, - ), - self.enable_secret_version: gapic_v1.method.wrap_method( - self.enable_secret_version, - default_timeout=60.0, - client_info=client_info, - ), - self.destroy_secret_version: gapic_v1.method.wrap_method( - self.destroy_secret_version, - default_timeout=60.0, - client_info=client_info, - ), - self.set_iam_policy: gapic_v1.method.wrap_method( - self.set_iam_policy, - default_timeout=60.0, - client_info=client_info, - ), - self.get_iam_policy: gapic_v1.method.wrap_method( - self.get_iam_policy, - default_timeout=60.0, - client_info=client_info, - ), - self.test_iam_permissions: gapic_v1.method.wrap_method( - self.test_iam_permissions, - default_timeout=60.0, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def list_secrets(self) -> Callable[ - [service.ListSecretsRequest], - Union[ - service.ListSecretsResponse, - Awaitable[service.ListSecretsResponse] - ]]: - raise NotImplementedError() - - @property - def create_secret(self) -> Callable[ - [service.CreateSecretRequest], - Union[ - resources.Secret, - Awaitable[resources.Secret] - ]]: - raise NotImplementedError() - - @property - def add_secret_version(self) -> Callable[ - [service.AddSecretVersionRequest], - Union[ - resources.SecretVersion, - Awaitable[resources.SecretVersion] - ]]: - raise NotImplementedError() - - @property - def get_secret(self) -> Callable[ - [service.GetSecretRequest], - Union[ - resources.Secret, - Awaitable[resources.Secret] - ]]: - raise NotImplementedError() - - @property - def update_secret(self) -> Callable[ - [service.UpdateSecretRequest], - Union[ - resources.Secret, - Awaitable[resources.Secret] - ]]: - raise NotImplementedError() - - @property - def delete_secret(self) -> Callable[ - [service.DeleteSecretRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def list_secret_versions(self) -> Callable[ - [service.ListSecretVersionsRequest], - Union[ - service.ListSecretVersionsResponse, - Awaitable[service.ListSecretVersionsResponse] - ]]: - raise NotImplementedError() - - @property - def get_secret_version(self) -> Callable[ - [service.GetSecretVersionRequest], - Union[ - resources.SecretVersion, - Awaitable[resources.SecretVersion] - ]]: - raise NotImplementedError() - - @property - def access_secret_version(self) -> Callable[ - [service.AccessSecretVersionRequest], - Union[ - service.AccessSecretVersionResponse, - Awaitable[service.AccessSecretVersionResponse] - ]]: - raise NotImplementedError() - - @property - def disable_secret_version(self) -> Callable[ - [service.DisableSecretVersionRequest], - Union[ - resources.SecretVersion, - Awaitable[resources.SecretVersion] - ]]: - raise NotImplementedError() - - @property - def enable_secret_version(self) -> Callable[ - [service.EnableSecretVersionRequest], - Union[ - resources.SecretVersion, - Awaitable[resources.SecretVersion] - ]]: - raise NotImplementedError() - - @property - def destroy_secret_version(self) -> Callable[ - [service.DestroySecretVersionRequest], - Union[ - resources.SecretVersion, - Awaitable[resources.SecretVersion] - ]]: - raise NotImplementedError() - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Union[ - iam_policy_pb2.TestIamPermissionsResponse, - Awaitable[iam_policy_pb2.TestIamPermissionsResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'SecretManagerServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py deleted file mode 100644 index ac32411..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py +++ /dev/null @@ -1,685 +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.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore -from .base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO - - -class SecretManagerServiceGrpcTransport(SecretManagerServiceTransport): - """gRPC backend transport for SecretManagerService. - - Secret Manager Service - - Manages secrets and operations using those secrets. Implements a - REST model with the following objects: - - - [Secret][google.cloud.secretmanager.v1.Secret] - - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - - 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 = 'secretmanager.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 = 'secretmanager.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 list_secrets(self) -> Callable[ - [service.ListSecretsRequest], - service.ListSecretsResponse]: - r"""Return a callable for the list secrets method over gRPC. - - Lists [Secrets][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.ListSecretsRequest], - ~.ListSecretsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secrets' not in self._stubs: - self._stubs['list_secrets'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/ListSecrets', - request_serializer=service.ListSecretsRequest.serialize, - response_deserializer=service.ListSecretsResponse.deserialize, - ) - return self._stubs['list_secrets'] - - @property - def create_secret(self) -> Callable[ - [service.CreateSecretRequest], - resources.Secret]: - r"""Return a callable for the create secret method over gRPC. - - Creates a new [Secret][google.cloud.secretmanager.v1.Secret] - containing no - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.CreateSecretRequest], - ~.Secret]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['create_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/CreateSecret', - request_serializer=service.CreateSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['create_secret'] - - @property - def add_secret_version(self) -> Callable[ - [service.AddSecretVersionRequest], - resources.SecretVersion]: - r"""Return a callable for the add secret version method over gRPC. - - Creates a new - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - containing secret data and attaches it to an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.AddSecretVersionRequest], - ~.SecretVersion]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'add_secret_version' not in self._stubs: - self._stubs['add_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/AddSecretVersion', - request_serializer=service.AddSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['add_secret_version'] - - @property - def get_secret(self) -> Callable[ - [service.GetSecretRequest], - resources.Secret]: - r"""Return a callable for the get secret method over gRPC. - - Gets metadata for a given - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.GetSecretRequest], - ~.Secret]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['get_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetSecret', - request_serializer=service.GetSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['get_secret'] - - @property - def update_secret(self) -> Callable[ - [service.UpdateSecretRequest], - resources.Secret]: - r"""Return a callable for the update secret method over gRPC. - - Updates metadata of an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.UpdateSecretRequest], - ~.Secret]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['update_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/UpdateSecret', - request_serializer=service.UpdateSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['update_secret'] - - @property - def delete_secret(self) -> Callable[ - [service.DeleteSecretRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete secret method over gRPC. - - Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.DeleteSecretRequest], - ~.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_secret' not in self._stubs: - self._stubs['delete_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DeleteSecret', - request_serializer=service.DeleteSecretRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_secret'] - - @property - def list_secret_versions(self) -> Callable[ - [service.ListSecretVersionsRequest], - service.ListSecretVersionsResponse]: - r"""Return a callable for the list secret versions method over gRPC. - - Lists - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - This call does not return secret data. - - Returns: - Callable[[~.ListSecretVersionsRequest], - ~.ListSecretVersionsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret_versions' not in self._stubs: - self._stubs['list_secret_versions'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/ListSecretVersions', - request_serializer=service.ListSecretVersionsRequest.serialize, - response_deserializer=service.ListSecretVersionsResponse.deserialize, - ) - return self._stubs['list_secret_versions'] - - @property - def get_secret_version(self) -> Callable[ - [service.GetSecretVersionRequest], - resources.SecretVersion]: - r"""Return a callable for the get secret version method over gRPC. - - Gets metadata for a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.GetSecretVersionRequest], - ~.SecretVersion]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret_version' not in self._stubs: - self._stubs['get_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetSecretVersion', - request_serializer=service.GetSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['get_secret_version'] - - @property - def access_secret_version(self) -> Callable[ - [service.AccessSecretVersionRequest], - service.AccessSecretVersionResponse]: - r"""Return a callable for the access secret version method over gRPC. - - Accesses a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - This call returns the secret data. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.AccessSecretVersionRequest], - ~.AccessSecretVersionResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'access_secret_version' not in self._stubs: - self._stubs['access_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion', - request_serializer=service.AccessSecretVersionRequest.serialize, - response_deserializer=service.AccessSecretVersionResponse.deserialize, - ) - return self._stubs['access_secret_version'] - - @property - def disable_secret_version(self) -> Callable[ - [service.DisableSecretVersionRequest], - resources.SecretVersion]: - r"""Return a callable for the disable secret version method over gRPC. - - Disables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. - - Returns: - Callable[[~.DisableSecretVersionRequest], - ~.SecretVersion]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'disable_secret_version' not in self._stubs: - self._stubs['disable_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DisableSecretVersion', - request_serializer=service.DisableSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['disable_secret_version'] - - @property - def enable_secret_version(self) -> Callable[ - [service.EnableSecretVersionRequest], - resources.SecretVersion]: - r"""Return a callable for the enable secret version method over gRPC. - - Enables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. - - Returns: - Callable[[~.EnableSecretVersionRequest], - ~.SecretVersion]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'enable_secret_version' not in self._stubs: - self._stubs['enable_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/EnableSecretVersion', - request_serializer=service.EnableSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['enable_secret_version'] - - @property - def destroy_secret_version(self) -> Callable[ - [service.DestroySecretVersionRequest], - resources.SecretVersion]: - r"""Return a callable for the destroy secret version method over gRPC. - - Destroys a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] - and irrevocably destroys the secret data. - - Returns: - Callable[[~.DestroySecretVersionRequest], - ~.SecretVersion]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'destroy_secret_version' not in self._stubs: - self._stubs['destroy_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DestroySecretVersion', - request_serializer=service.DestroySecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['destroy_secret_version'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets the access control policy on the specified secret. Replaces - any existing policy. - - Permissions on - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - are enforced according to the policy set on the associated - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.SetIamPolicyRequest], - ~.Policy]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a secret. - Returns empty policy if the secret exists and does not - have a policy set. - - Returns: - Callable[[~.GetIamPolicyRequest], - ~.Policy]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - iam_policy_pb2.TestIamPermissionsResponse]: - r"""Return a callable for the test iam permissions method over gRPC. - - Returns permissions that a caller has for the specified secret. - If the secret does not exist, this call returns an empty set of - permissions, not a NOT_FOUND error. - - Note: This operation is designed to be used for building - permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without - warning. - - Returns: - Callable[[~.TestIamPermissionsRequest], - ~.TestIamPermissionsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - def close(self): - self.grpc_channel.close() - -__all__ = ( - 'SecretManagerServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py deleted file mode 100644 index 3d01893..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,690 +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.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore -from .base import SecretManagerServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import SecretManagerServiceGrpcTransport - - -class SecretManagerServiceGrpcAsyncIOTransport(SecretManagerServiceTransport): - """gRPC AsyncIO backend transport for SecretManagerService. - - Secret Manager Service - - Manages secrets and operations using those secrets. Implements a - REST model with the following objects: - - - [Secret][google.cloud.secretmanager.v1.Secret] - - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - - 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 = 'secretmanager.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 = 'secretmanager.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 list_secrets(self) -> Callable[ - [service.ListSecretsRequest], - Awaitable[service.ListSecretsResponse]]: - r"""Return a callable for the list secrets method over gRPC. - - Lists [Secrets][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.ListSecretsRequest], - Awaitable[~.ListSecretsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secrets' not in self._stubs: - self._stubs['list_secrets'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/ListSecrets', - request_serializer=service.ListSecretsRequest.serialize, - response_deserializer=service.ListSecretsResponse.deserialize, - ) - return self._stubs['list_secrets'] - - @property - def create_secret(self) -> Callable[ - [service.CreateSecretRequest], - Awaitable[resources.Secret]]: - r"""Return a callable for the create secret method over gRPC. - - Creates a new [Secret][google.cloud.secretmanager.v1.Secret] - containing no - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.CreateSecretRequest], - Awaitable[~.Secret]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['create_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/CreateSecret', - request_serializer=service.CreateSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['create_secret'] - - @property - def add_secret_version(self) -> Callable[ - [service.AddSecretVersionRequest], - Awaitable[resources.SecretVersion]]: - r"""Return a callable for the add secret version method over gRPC. - - Creates a new - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - containing secret data and attaches it to an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.AddSecretVersionRequest], - Awaitable[~.SecretVersion]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'add_secret_version' not in self._stubs: - self._stubs['add_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/AddSecretVersion', - request_serializer=service.AddSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['add_secret_version'] - - @property - def get_secret(self) -> Callable[ - [service.GetSecretRequest], - Awaitable[resources.Secret]]: - r"""Return a callable for the get secret method over gRPC. - - Gets metadata for a given - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.GetSecretRequest], - Awaitable[~.Secret]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['get_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetSecret', - request_serializer=service.GetSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['get_secret'] - - @property - def update_secret(self) -> Callable[ - [service.UpdateSecretRequest], - Awaitable[resources.Secret]]: - r"""Return a callable for the update secret method over gRPC. - - Updates metadata of an existing - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.UpdateSecretRequest], - Awaitable[~.Secret]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret' not in self._stubs: - self._stubs['update_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/UpdateSecret', - request_serializer=service.UpdateSecretRequest.serialize, - response_deserializer=resources.Secret.deserialize, - ) - return self._stubs['update_secret'] - - @property - def delete_secret(self) -> Callable[ - [service.DeleteSecretRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete secret method over gRPC. - - Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.DeleteSecretRequest], - 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_secret' not in self._stubs: - self._stubs['delete_secret'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DeleteSecret', - request_serializer=service.DeleteSecretRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_secret'] - - @property - def list_secret_versions(self) -> Callable[ - [service.ListSecretVersionsRequest], - Awaitable[service.ListSecretVersionsResponse]]: - r"""Return a callable for the list secret versions method over gRPC. - - Lists - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - This call does not return secret data. - - Returns: - Callable[[~.ListSecretVersionsRequest], - Awaitable[~.ListSecretVersionsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret_versions' not in self._stubs: - self._stubs['list_secret_versions'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/ListSecretVersions', - request_serializer=service.ListSecretVersionsRequest.serialize, - response_deserializer=service.ListSecretVersionsResponse.deserialize, - ) - return self._stubs['list_secret_versions'] - - @property - def get_secret_version(self) -> Callable[ - [service.GetSecretVersionRequest], - Awaitable[resources.SecretVersion]]: - r"""Return a callable for the get secret version method over gRPC. - - Gets metadata for a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.GetSecretVersionRequest], - Awaitable[~.SecretVersion]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_secret_version' not in self._stubs: - self._stubs['get_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetSecretVersion', - request_serializer=service.GetSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['get_secret_version'] - - @property - def access_secret_version(self) -> Callable[ - [service.AccessSecretVersionRequest], - Awaitable[service.AccessSecretVersionResponse]]: - r"""Return a callable for the access secret version method over gRPC. - - Accesses a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - This call returns the secret data. - - ``projects/*/secrets/*/versions/latest`` is an alias to the most - recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Returns: - Callable[[~.AccessSecretVersionRequest], - Awaitable[~.AccessSecretVersionResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'access_secret_version' not in self._stubs: - self._stubs['access_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion', - request_serializer=service.AccessSecretVersionRequest.serialize, - response_deserializer=service.AccessSecretVersionResponse.deserialize, - ) - return self._stubs['access_secret_version'] - - @property - def disable_secret_version(self) -> Callable[ - [service.DisableSecretVersionRequest], - Awaitable[resources.SecretVersion]]: - r"""Return a callable for the disable secret version method over gRPC. - - Disables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. - - Returns: - Callable[[~.DisableSecretVersionRequest], - Awaitable[~.SecretVersion]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'disable_secret_version' not in self._stubs: - self._stubs['disable_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DisableSecretVersion', - request_serializer=service.DisableSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['disable_secret_version'] - - @property - def enable_secret_version(self) -> Callable[ - [service.EnableSecretVersionRequest], - Awaitable[resources.SecretVersion]]: - r"""Return a callable for the enable secret version method over gRPC. - - Enables a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. - - Returns: - Callable[[~.EnableSecretVersionRequest], - Awaitable[~.SecretVersion]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'enable_secret_version' not in self._stubs: - self._stubs['enable_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/EnableSecretVersion', - request_serializer=service.EnableSecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['enable_secret_version'] - - @property - def destroy_secret_version(self) -> Callable[ - [service.DestroySecretVersionRequest], - Awaitable[resources.SecretVersion]]: - r"""Return a callable for the destroy secret version method over gRPC. - - Destroys a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Sets the - [state][google.cloud.secretmanager.v1.SecretVersion.state] of - the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to - [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] - and irrevocably destroys the secret data. - - Returns: - Callable[[~.DestroySecretVersionRequest], - Awaitable[~.SecretVersion]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'destroy_secret_version' not in self._stubs: - self._stubs['destroy_secret_version'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/DestroySecretVersion', - request_serializer=service.DestroySecretVersionRequest.serialize, - response_deserializer=resources.SecretVersion.deserialize, - ) - return self._stubs['destroy_secret_version'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets the access control policy on the specified secret. Replaces - any existing policy. - - Permissions on - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - are enforced according to the policy set on the associated - [Secret][google.cloud.secretmanager.v1.Secret]. - - Returns: - Callable[[~.SetIamPolicyRequest], - Awaitable[~.Policy]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a secret. - Returns empty policy if the secret exists and does not - have a policy set. - - Returns: - Callable[[~.GetIamPolicyRequest], - Awaitable[~.Policy]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: - r"""Return a callable for the test iam permissions method over gRPC. - - Returns permissions that a caller has for the specified secret. - If the secret does not exist, this call returns an empty set of - permissions, not a NOT_FOUND error. - - Note: This operation is designed to be used for building - permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without - warning. - - Returns: - Callable[[~.TestIamPermissionsRequest], - Awaitable[~.TestIamPermissionsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( - '/google.cloud.secretmanager.v1.SecretManagerService/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'SecretManagerServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py deleted file mode 100644 index 61a50e0..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/__init__.py +++ /dev/null @@ -1,70 +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 .resources import ( - CustomerManagedEncryption, - CustomerManagedEncryptionStatus, - Replication, - ReplicationStatus, - Rotation, - Secret, - SecretPayload, - SecretVersion, - Topic, -) -from .service import ( - AccessSecretVersionRequest, - AccessSecretVersionResponse, - AddSecretVersionRequest, - CreateSecretRequest, - DeleteSecretRequest, - DestroySecretVersionRequest, - DisableSecretVersionRequest, - EnableSecretVersionRequest, - GetSecretRequest, - GetSecretVersionRequest, - ListSecretsRequest, - ListSecretsResponse, - ListSecretVersionsRequest, - ListSecretVersionsResponse, - UpdateSecretRequest, -) - -__all__ = ( - 'CustomerManagedEncryption', - 'CustomerManagedEncryptionStatus', - 'Replication', - 'ReplicationStatus', - 'Rotation', - 'Secret', - 'SecretPayload', - 'SecretVersion', - 'Topic', - 'AccessSecretVersionRequest', - 'AccessSecretVersionResponse', - 'AddSecretVersionRequest', - 'CreateSecretRequest', - 'DeleteSecretRequest', - 'DestroySecretVersionRequest', - 'DisableSecretVersionRequest', - 'EnableSecretVersionRequest', - 'GetSecretRequest', - 'GetSecretVersionRequest', - 'ListSecretsRequest', - 'ListSecretsResponse', - 'ListSecretVersionsRequest', - 'ListSecretVersionsResponse', - 'UpdateSecretRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py deleted file mode 100644 index 04a5cf3..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/resources.py +++ /dev/null @@ -1,558 +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 duration_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.secretmanager.v1', - manifest={ - 'Secret', - 'SecretVersion', - 'Replication', - 'CustomerManagedEncryption', - 'ReplicationStatus', - 'CustomerManagedEncryptionStatus', - 'Topic', - 'Rotation', - 'SecretPayload', - }, -) - - -class Secret(proto.Message): - r"""A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret - whose value and versions can be accessed. - - A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero - or more - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that - represent the secret data. - - Attributes: - name (str): - Output only. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] in the format - ``projects/*/secrets/*``. - replication (google.cloud.secretmanager_v1.types.Replication): - Required. Immutable. The replication policy of the secret - data attached to the - [Secret][google.cloud.secretmanager.v1.Secret]. - - The replication policy cannot be changed after the Secret - has been created. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time at which the - [Secret][google.cloud.secretmanager.v1.Secret] was created. - labels (Sequence[google.cloud.secretmanager_v1.types.Secret.LabelsEntry]): - The labels assigned to this Secret. - - Label keys must be between 1 and 63 characters long, have a - UTF-8 encoding of maximum 128 bytes, and must conform to the - following PCRE regular expression: - ``[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`` - - Label values must be between 0 and 63 characters long, have - a UTF-8 encoding of maximum 128 bytes, and must conform to - the following PCRE regular expression: - ``[\p{Ll}\p{Lo}\p{N}_-]{0,63}`` - - No more than 64 labels can be assigned to a given resource. - topics (Sequence[google.cloud.secretmanager_v1.types.Topic]): - Optional. A list of up to 10 Pub/Sub topics - to which messages are published when control - plane operations are called on the secret or its - versions. - expire_time (google.protobuf.timestamp_pb2.Timestamp): - Optional. Timestamp in UTC when the - [Secret][google.cloud.secretmanager.v1.Secret] is scheduled - to expire. This is always provided on output, regardless of - what was sent on input. - ttl (google.protobuf.duration_pb2.Duration): - Input only. The TTL for the - [Secret][google.cloud.secretmanager.v1.Secret]. - etag (str): - Optional. Etag of the currently stored - [Secret][google.cloud.secretmanager.v1.Secret]. - rotation (google.cloud.secretmanager_v1.types.Rotation): - Optional. Rotation policy attached to the - [Secret][google.cloud.secretmanager.v1.Secret]. May be - excluded if there is no rotation policy. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - replication = proto.Field( - proto.MESSAGE, - number=2, - message='Replication', - ) - create_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - topics = proto.RepeatedField( - proto.MESSAGE, - number=5, - message='Topic', - ) - expire_time = proto.Field( - proto.MESSAGE, - number=6, - oneof='expiration', - message=timestamp_pb2.Timestamp, - ) - ttl = proto.Field( - proto.MESSAGE, - number=7, - oneof='expiration', - message=duration_pb2.Duration, - ) - etag = proto.Field( - proto.STRING, - number=8, - ) - rotation = proto.Field( - proto.MESSAGE, - number=9, - message='Rotation', - ) - - -class SecretVersion(proto.Message): - r"""A secret version resource in the Secret Manager API. - - Attributes: - name (str): - Output only. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - IDs in a [Secret][google.cloud.secretmanager.v1.Secret] - start at 1 and are incremented for each subsequent version - of the secret. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time at which the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - was created. - destroy_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time this - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - was destroyed. Only present if - [state][google.cloud.secretmanager.v1.SecretVersion.state] - is - [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]. - state (google.cloud.secretmanager_v1.types.SecretVersion.State): - Output only. The current state of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - replication_status (google.cloud.secretmanager_v1.types.ReplicationStatus): - The replication status of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - etag (str): - Output only. Etag of the currently stored - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - """ - class State(proto.Enum): - r"""The state of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], - indicating if it can be accessed. - """ - STATE_UNSPECIFIED = 0 - ENABLED = 1 - DISABLED = 2 - DESTROYED = 3 - - name = proto.Field( - proto.STRING, - number=1, - ) - create_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - destroy_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - state = proto.Field( - proto.ENUM, - number=4, - enum=State, - ) - replication_status = proto.Field( - proto.MESSAGE, - number=5, - message='ReplicationStatus', - ) - etag = proto.Field( - proto.STRING, - number=6, - ) - - -class Replication(proto.Message): - r"""A policy that defines the replication and encryption - configuration of data. - - Attributes: - automatic (google.cloud.secretmanager_v1.types.Replication.Automatic): - The [Secret][google.cloud.secretmanager.v1.Secret] will - automatically be replicated without any restrictions. - user_managed (google.cloud.secretmanager_v1.types.Replication.UserManaged): - The [Secret][google.cloud.secretmanager.v1.Secret] will only - be replicated into the locations specified. - """ - - class Automatic(proto.Message): - r"""A replication policy that replicates the - [Secret][google.cloud.secretmanager.v1.Secret] payload without any - restrictions. - - Attributes: - customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryption): - Optional. The customer-managed encryption configuration of - the [Secret][google.cloud.secretmanager.v1.Secret]. If no - configuration is provided, Google-managed default encryption - is used. - - Updates to the - [Secret][google.cloud.secretmanager.v1.Secret] encryption - configuration only apply to - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - added afterwards. They do not apply retroactively to - existing - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - """ - - customer_managed_encryption = proto.Field( - proto.MESSAGE, - number=1, - message='CustomerManagedEncryption', - ) - - class UserManaged(proto.Message): - r"""A replication policy that replicates the - [Secret][google.cloud.secretmanager.v1.Secret] payload into the - locations specified in [Secret.replication.user_managed.replicas][] - - Attributes: - replicas (Sequence[google.cloud.secretmanager_v1.types.Replication.UserManaged.Replica]): - Required. The list of Replicas for this - [Secret][google.cloud.secretmanager.v1.Secret]. - - Cannot be empty. - """ - - class Replica(proto.Message): - r"""Represents a Replica for this - [Secret][google.cloud.secretmanager.v1.Secret]. - - Attributes: - location (str): - The canonical IDs of the location to replicate data. For - example: ``"us-east1"``. - customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryption): - Optional. The customer-managed encryption configuration of - the [User-Managed Replica][Replication.UserManaged.Replica]. - If no configuration is provided, Google-managed default - encryption is used. - - Updates to the - [Secret][google.cloud.secretmanager.v1.Secret] encryption - configuration only apply to - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - added afterwards. They do not apply retroactively to - existing - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - """ - - location = proto.Field( - proto.STRING, - number=1, - ) - customer_managed_encryption = proto.Field( - proto.MESSAGE, - number=2, - message='CustomerManagedEncryption', - ) - - replicas = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Replication.UserManaged.Replica', - ) - - automatic = proto.Field( - proto.MESSAGE, - number=1, - oneof='replication', - message=Automatic, - ) - user_managed = proto.Field( - proto.MESSAGE, - number=2, - oneof='replication', - message=UserManaged, - ) - - -class CustomerManagedEncryption(proto.Message): - r"""Configuration for encrypting secret payloads using customer- - anaged encryption keys (CMEK). - - Attributes: - kms_key_name (str): - Required. The resource name of the Cloud KMS CryptoKey used - to encrypt secret payloads. - - For secrets using the - [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged] - replication policy type, Cloud KMS CryptoKeys must reside in - the same location as the [replica - location][Secret.UserManaged.Replica.location]. - - For secrets using the - [Automatic][google.cloud.secretmanager.v1.Replication.Automatic] - replication policy type, Cloud KMS CryptoKeys must reside in - ``global``. - - The expected format is - ``projects/*/locations/*/keyRings/*/cryptoKeys/*``. - """ - - kms_key_name = proto.Field( - proto.STRING, - number=1, - ) - - -class ReplicationStatus(proto.Message): - r"""The replication status of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Attributes: - automatic (google.cloud.secretmanager_v1.types.ReplicationStatus.AutomaticStatus): - Describes the replication status of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - with automatic replication. - - Only populated if the parent - [Secret][google.cloud.secretmanager.v1.Secret] has an - automatic replication policy. - user_managed (google.cloud.secretmanager_v1.types.ReplicationStatus.UserManagedStatus): - Describes the replication status of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - with user-managed replication. - - Only populated if the parent - [Secret][google.cloud.secretmanager.v1.Secret] has a - user-managed replication policy. - """ - - class AutomaticStatus(proto.Message): - r"""The replication status of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using - automatic replication. - - Only populated if the parent - [Secret][google.cloud.secretmanager.v1.Secret] has an automatic - replication policy. - - Attributes: - customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryptionStatus): - Output only. The customer-managed encryption status of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Only populated if customer-managed encryption is used. - """ - - customer_managed_encryption = proto.Field( - proto.MESSAGE, - number=1, - message='CustomerManagedEncryptionStatus', - ) - - class UserManagedStatus(proto.Message): - r"""The replication status of a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using - user-managed replication. - - Only populated if the parent - [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed - replication policy. - - Attributes: - replicas (Sequence[google.cloud.secretmanager_v1.types.ReplicationStatus.UserManagedStatus.ReplicaStatus]): - Output only. The list of replica statuses for the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - """ - - class ReplicaStatus(proto.Message): - r"""Describes the status of a user-managed replica for the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Attributes: - location (str): - Output only. The canonical ID of the replica location. For - example: ``"us-east1"``. - customer_managed_encryption (google.cloud.secretmanager_v1.types.CustomerManagedEncryptionStatus): - Output only. The customer-managed encryption status of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Only populated if customer-managed encryption is used. - """ - - location = proto.Field( - proto.STRING, - number=1, - ) - customer_managed_encryption = proto.Field( - proto.MESSAGE, - number=2, - message='CustomerManagedEncryptionStatus', - ) - - replicas = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='ReplicationStatus.UserManagedStatus.ReplicaStatus', - ) - - automatic = proto.Field( - proto.MESSAGE, - number=1, - oneof='replication_status', - message=AutomaticStatus, - ) - user_managed = proto.Field( - proto.MESSAGE, - number=2, - oneof='replication_status', - message=UserManagedStatus, - ) - - -class CustomerManagedEncryptionStatus(proto.Message): - r"""Describes the status of customer-managed encryption. - - Attributes: - kms_key_version_name (str): - Required. The resource name of the Cloud KMS - CryptoKeyVersion used to encrypt the secret payload, in the - following format: - ``projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*``. - """ - - kms_key_version_name = proto.Field( - proto.STRING, - number=1, - ) - - -class Topic(proto.Message): - r"""A Pub/Sub topic which Secret Manager will publish to when - control plane events occur on this secret. - - Attributes: - name (str): - Required. The resource name of the Pub/Sub topic that will - be published to, in the following format: - ``projects/*/topics/*``. For publication to succeed, the - Secret Manager P4SA must have ``pubsub.publisher`` - permissions on the topic. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class Rotation(proto.Message): - r"""The rotation time and period for a - [Secret][google.cloud.secretmanager.v1.Secret]. At - next_rotation_time, Secret Manager will send a Pub/Sub notification - to the topics configured on the Secret. - [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be - set to configure rotation. - - Attributes: - next_rotation_time (google.protobuf.timestamp_pb2.Timestamp): - Optional. Timestamp in UTC at which the - [Secret][google.cloud.secretmanager.v1.Secret] is scheduled - to rotate. Cannot be set to less than 300s (5 min) in the - future and at most 3153600000s (100 years). - - [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] - MUST be set if - [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] - is set. - rotation_period (google.protobuf.duration_pb2.Duration): - Input only. The Duration between rotation notifications. - Must be in seconds and at least 3600s (1h) and at most - 3153600000s (100 years). - - If - [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] - is set, - [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] - must be set. - [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] - will be advanced by this period when the service - automatically sends rotation notifications. - """ - - next_rotation_time = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - rotation_period = proto.Field( - proto.MESSAGE, - number=2, - message=duration_pb2.Duration, - ) - - -class SecretPayload(proto.Message): - r"""A secret payload resource in the Secret Manager API. This contains - the sensitive secret payload that is associated with a - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - - Attributes: - data (bytes): - The secret data. Must be no larger than - 64KiB. - """ - - data = proto.Field( - proto.BYTES, - number=1, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py b/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py deleted file mode 100644 index f392df8..0000000 --- a/owl-bot-staging/v1/google/cloud/secretmanager_v1/types/service.py +++ /dev/null @@ -1,488 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.cloud.secretmanager_v1.types import resources -from google.protobuf import field_mask_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.secretmanager.v1', - manifest={ - 'ListSecretsRequest', - 'ListSecretsResponse', - 'CreateSecretRequest', - 'AddSecretVersionRequest', - 'GetSecretRequest', - 'ListSecretVersionsRequest', - 'ListSecretVersionsResponse', - 'GetSecretVersionRequest', - 'UpdateSecretRequest', - 'AccessSecretVersionRequest', - 'AccessSecretVersionResponse', - 'DeleteSecretRequest', - 'DisableSecretVersionRequest', - 'EnableSecretVersionRequest', - 'DestroySecretVersionRequest', - }, -) - - -class ListSecretsRequest(proto.Message): - r"""Request message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - - Attributes: - parent (str): - Required. The resource name of the project associated with - the [Secrets][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*``. - page_size (int): - Optional. The maximum number of results to be - returned in a single page. If set to 0, the - server decides the number of results to return. - If the number is greater than 25000, it is - capped at 25000. - page_token (str): - Optional. Pagination token, returned earlier via - [ListSecretsResponse.next_page_token][google.cloud.secretmanager.v1.ListSecretsResponse.next_page_token]. - filter (str): - Optional. Filter string, adhering to the rules in - `List-operation - filtering `__. - List only secrets matching the filter. If filter is empty, - all secrets are listed. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - - -class ListSecretsResponse(proto.Message): - r"""Response message for - [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets]. - - Attributes: - secrets (Sequence[google.cloud.secretmanager_v1.types.Secret]): - The list of [Secrets][google.cloud.secretmanager.v1.Secret] - sorted in reverse by create_time (newest first). - next_page_token (str): - A token to retrieve the next page of results. Pass this - value in - [ListSecretsRequest.page_token][google.cloud.secretmanager.v1.ListSecretsRequest.page_token] - to retrieve the next page. - total_size (int): - The total number of - [Secrets][google.cloud.secretmanager.v1.Secret]. - """ - - @property - def raw_page(self): - return self - - secrets = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=resources.Secret, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - total_size = proto.Field( - proto.INT32, - number=3, - ) - - -class CreateSecretRequest(proto.Message): - r"""Request message for - [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret]. - - Attributes: - parent (str): - Required. The resource name of the project to associate with - the [Secret][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*``. - secret_id (str): - Required. This must be unique within the project. - - A secret ID is a string with a maximum length of 255 - characters and can contain uppercase and lowercase letters, - numerals, and the hyphen (``-``) and underscore (``_``) - characters. - secret (google.cloud.secretmanager_v1.types.Secret): - Required. A [Secret][google.cloud.secretmanager.v1.Secret] - with initial field values. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - secret_id = proto.Field( - proto.STRING, - number=2, - ) - secret = proto.Field( - proto.MESSAGE, - number=3, - message=resources.Secret, - ) - - -class AddSecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. - - Attributes: - parent (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to associate - with the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*``. - payload (google.cloud.secretmanager_v1.types.SecretPayload): - Required. The secret payload of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - payload = proto.Field( - proto.MESSAGE, - number=2, - message=resources.SecretPayload, - ) - - -class GetSecretRequest(proto.Message): - r"""Request message for - [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret]. - - Attributes: - name (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret], in the - format ``projects/*/secrets/*``. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class ListSecretVersionsRequest(proto.Message): - r"""Request message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - - Attributes: - parent (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] associated - with the - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - to list, in the format ``projects/*/secrets/*``. - page_size (int): - Optional. The maximum number of results to be - returned in a single page. If set to 0, the - server decides the number of results to return. - If the number is greater than 25000, it is - capped at 25000. - page_token (str): - Optional. Pagination token, returned earlier via - ListSecretVersionsResponse.next_page_token][]. - filter (str): - Optional. Filter string, adhering to the rules in - `List-operation - filtering `__. - List only secret versions matching the filter. If filter is - empty, all secret versions are listed. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - - -class ListSecretVersionsResponse(proto.Message): - r"""Response message for - [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions]. - - Attributes: - versions (Sequence[google.cloud.secretmanager_v1.types.SecretVersion]): - The list of - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] - sorted in reverse by create_time (newest first). - next_page_token (str): - A token to retrieve the next page of results. Pass this - value in - [ListSecretVersionsRequest.page_token][google.cloud.secretmanager.v1.ListSecretVersionsRequest.page_token] - to retrieve the next page. - total_size (int): - The total number of - [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - """ - - @property - def raw_page(self): - return self - - versions = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=resources.SecretVersion, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - total_size = proto.Field( - proto.INT32, - number=3, - ) - - -class GetSecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion]. - - Attributes: - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to the - most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateSecretRequest(proto.Message): - r"""Request message for - [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. - - Attributes: - secret (google.cloud.secretmanager_v1.types.Secret): - Required. [Secret][google.cloud.secretmanager.v1.Secret] - with updated field values. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. Specifies the fields to be updated. - """ - - secret = proto.Field( - proto.MESSAGE, - number=1, - message=resources.Secret, - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class AccessSecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - - Attributes: - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - - ``projects/*/secrets/*/versions/latest`` is an alias to the - most recently created - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class AccessSecretVersionResponse(proto.Message): - r"""Response message for - [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]. - - Attributes: - name (str): - The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - in the format ``projects/*/secrets/*/versions/*``. - payload (google.cloud.secretmanager_v1.types.SecretPayload): - Secret payload - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - payload = proto.Field( - proto.MESSAGE, - number=2, - message=resources.SecretPayload, - ) - - -class DeleteSecretRequest(proto.Message): - r"""Request message for - [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret]. - - Attributes: - name (str): - Required. The resource name of the - [Secret][google.cloud.secretmanager.v1.Secret] to delete in - the format ``projects/*/secrets/*``. - etag (str): - Optional. Etag of the - [Secret][google.cloud.secretmanager.v1.Secret]. The request - succeeds if it matches the etag of the currently stored - secret object. If the etag is omitted, the request succeeds. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - etag = proto.Field( - proto.STRING, - number=2, - ) - - -class DisableSecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion]. - - Attributes: - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to disable in the format - ``projects/*/secrets/*/versions/*``. - etag (str): - Optional. Etag of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - The request succeeds if it matches the etag of the currently - stored secret version object. If the etag is omitted, the - request succeeds. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - etag = proto.Field( - proto.STRING, - number=2, - ) - - -class EnableSecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion]. - - Attributes: - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to enable in the format ``projects/*/secrets/*/versions/*``. - etag (str): - Optional. Etag of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - The request succeeds if it matches the etag of the currently - stored secret version object. If the etag is omitted, the - request succeeds. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - etag = proto.Field( - proto.STRING, - number=2, - ) - - -class DestroySecretVersionRequest(proto.Message): - r"""Request message for - [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion]. - - Attributes: - name (str): - Required. The resource name of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] - to destroy in the format - ``projects/*/secrets/*/versions/*``. - etag (str): - Optional. Etag of the - [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - The request succeeds if it matches the etag of the currently - stored secret version object. If the etag is omitted, the - request succeeds. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - etag = proto.Field( - proto.STRING, - number=2, - ) - - -__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 4505b48..0000000 --- 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 798947b..0000000 --- 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/secretmanager_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_secretmanager_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_secretmanager_v1_keywords.py deleted file mode 100644 index 1f5e1da..0000000 --- a/owl-bot-staging/v1/scripts/fixup_secretmanager_v1_keywords.py +++ /dev/null @@ -1,190 +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 secretmanagerCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'access_secret_version': ('name', ), - 'add_secret_version': ('parent', 'payload', ), - 'create_secret': ('parent', 'secret_id', 'secret', ), - 'delete_secret': ('name', 'etag', ), - 'destroy_secret_version': ('name', 'etag', ), - 'disable_secret_version': ('name', 'etag', ), - 'enable_secret_version': ('name', 'etag', ), - 'get_iam_policy': ('resource', 'options', ), - 'get_secret': ('name', ), - 'get_secret_version': ('name', ), - 'list_secrets': ('parent', 'page_size', 'page_token', 'filter', ), - 'list_secret_versions': ('parent', 'page_size', 'page_token', 'filter', ), - 'set_iam_policy': ('resource', 'policy', ), - 'test_iam_permissions': ('resource', 'permissions', ), - 'update_secret': ('secret', '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=secretmanagerCallTransformer(), -): - """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 secretmanager 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 f519a65..0000000 --- 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-secretmanager', - 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', 'grpc-google-iam-v1 >= 0.12.3, < 0.13dev', ), - 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 b54a5fc..0000000 --- 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 b54a5fc..0000000 --- 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 b54a5fc..0000000 --- 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/secretmanager_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/secretmanager_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/secretmanager_v1/test_secret_manager_service.py b/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py deleted file mode 100644 index dd82562..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py +++ /dev/null @@ -1,4780 +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.secretmanager_v1.services.secret_manager_service import SecretManagerServiceAsyncClient -from google.cloud.secretmanager_v1.services.secret_manager_service import SecretManagerServiceClient -from google.cloud.secretmanager_v1.services.secret_manager_service import pagers -from google.cloud.secretmanager_v1.services.secret_manager_service import transports -from google.cloud.secretmanager_v1.services.secret_manager_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.secretmanager_v1.types import resources -from google.cloud.secretmanager_v1.types import service -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import options_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import expr_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 SecretManagerServiceClient._get_default_mtls_endpoint(None) is None - assert SecretManagerServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert SecretManagerServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert SecretManagerServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert SecretManagerServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert SecretManagerServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - SecretManagerServiceClient, - SecretManagerServiceAsyncClient, -]) -def test_secret_manager_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 == 'secretmanager.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.SecretManagerServiceGrpcTransport, "grpc"), - (transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_secret_manager_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", [ - SecretManagerServiceClient, - SecretManagerServiceAsyncClient, -]) -def test_secret_manager_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 == 'secretmanager.googleapis.com:443' - - -def test_secret_manager_service_client_get_transport_class(): - transport = SecretManagerServiceClient.get_transport_class() - available_transports = [ - transports.SecretManagerServiceGrpcTransport, - ] - assert transport in available_transports - - transport = SecretManagerServiceClient.get_transport_class("grpc") - assert transport == transports.SecretManagerServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), - (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(SecretManagerServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceClient)) -@mock.patch.object(SecretManagerServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceAsyncClient)) -def test_secret_manager_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(SecretManagerServiceClient, '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(SecretManagerServiceClient, '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", [ - (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc", "true"), - (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc", "false"), - (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(SecretManagerServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceClient)) -@mock.patch.object(SecretManagerServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SecretManagerServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_secret_manager_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", [ - (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), - (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_secret_manager_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", [ - (SecretManagerServiceClient, transports.SecretManagerServiceGrpcTransport, "grpc"), - (SecretManagerServiceAsyncClient, transports.SecretManagerServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_secret_manager_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_secret_manager_service_client_client_options_from_dict(): - with mock.patch('google.cloud.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = SecretManagerServiceClient( - 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_list_secrets(transport: str = 'grpc', request_type=service.ListSecretsRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secrets), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretsResponse( - next_page_token='next_page_token_value', - total_size=1086, - ) - response = client.list_secrets(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSecretsPager) - assert response.next_page_token == 'next_page_token_value' - assert response.total_size == 1086 - - -def test_list_secrets_from_dict(): - test_list_secrets(request_type=dict) - - -def test_list_secrets_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 = SecretManagerServiceClient( - 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_secrets), - '__call__') as call: - client.list_secrets() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretsRequest() - - -@pytest.mark.asyncio -async def test_list_secrets_async(transport: str = 'grpc_asyncio', request_type=service.ListSecretsRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secrets), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse( - next_page_token='next_page_token_value', - total_size=1086, - )) - response = await client.list_secrets(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSecretsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - assert response.total_size == 1086 - - -@pytest.mark.asyncio -async def test_list_secrets_async_from_dict(): - await test_list_secrets_async(request_type=dict) - - -def test_list_secrets_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.ListSecretsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - call.return_value = service.ListSecretsResponse() - client.list_secrets(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_secrets_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.ListSecretsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse()) - await client.list_secrets(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_secrets_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_secrets( - 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_secrets_flattened_error(): - client = SecretManagerServiceClient( - 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_secrets( - service.ListSecretsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_secrets_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_secrets( - 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_secrets_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secrets( - service.ListSecretsRequest(), - parent='parent_value', - ) - - -def test_list_secrets_pager(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - resources.Secret(), - ], - next_page_token='abc', - ), - service.ListSecretsResponse( - secrets=[], - next_page_token='def', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - ], - next_page_token='ghi', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_secrets(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, resources.Secret) - for i in results) - -def test_list_secrets_pages(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - resources.Secret(), - ], - next_page_token='abc', - ), - service.ListSecretsResponse( - secrets=[], - next_page_token='def', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - ], - next_page_token='ghi', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - ], - ), - RuntimeError, - ) - pages = list(client.list_secrets(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_secrets_async_pager(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - resources.Secret(), - ], - next_page_token='abc', - ), - service.ListSecretsResponse( - secrets=[], - next_page_token='def', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - ], - next_page_token='ghi', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_secrets(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, resources.Secret) - for i in responses) - -@pytest.mark.asyncio -async def test_list_secrets_async_pages(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secrets), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - resources.Secret(), - ], - next_page_token='abc', - ), - service.ListSecretsResponse( - secrets=[], - next_page_token='def', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - ], - next_page_token='ghi', - ), - service.ListSecretsResponse( - secrets=[ - resources.Secret(), - resources.Secret(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_secrets(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_create_secret(transport: str = 'grpc', request_type=service.CreateSecretRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret( - name='name_value', - etag='etag_value', - expire_time=timestamp_pb2.Timestamp(seconds=751), - ) - response = client.create_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -def test_create_secret_from_dict(): - test_create_secret(request_type=dict) - - -def test_create_secret_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 = SecretManagerServiceClient( - 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_secret), - '__call__') as call: - client.create_secret() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateSecretRequest() - - -@pytest.mark.asyncio -async def test_create_secret_async(transport: str = 'grpc_asyncio', request_type=service.CreateSecretRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( - name='name_value', - etag='etag_value', - )) - response = await client.create_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_create_secret_async_from_dict(): - await test_create_secret_async(request_type=dict) - - -def test_create_secret_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.CreateSecretRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_secret), - '__call__') as call: - call.return_value = resources.Secret() - client.create_secret(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_secret_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.CreateSecretRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_secret), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - await client.create_secret(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_secret_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_secret( - parent='parent_value', - secret_id='secret_id_value', - secret=resources.Secret(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].secret_id == 'secret_id_value' - assert args[0].secret == resources.Secret(name='name_value') - - -def test_create_secret_flattened_error(): - client = SecretManagerServiceClient( - 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_secret( - service.CreateSecretRequest(), - parent='parent_value', - secret_id='secret_id_value', - secret=resources.Secret(name='name_value'), - ) - - -@pytest.mark.asyncio -async def test_create_secret_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_secret( - parent='parent_value', - secret_id='secret_id_value', - secret=resources.Secret(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].secret_id == 'secret_id_value' - assert args[0].secret == resources.Secret(name='name_value') - - -@pytest.mark.asyncio -async def test_create_secret_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret( - service.CreateSecretRequest(), - parent='parent_value', - secret_id='secret_id_value', - secret=resources.Secret(name='name_value'), - ) - - -def test_add_secret_version(transport: str = 'grpc', request_type=service.AddSecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - ) - response = client.add_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.AddSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -def test_add_secret_version_from_dict(): - test_add_secret_version(request_type=dict) - - -def test_add_secret_version_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 = SecretManagerServiceClient( - 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.add_secret_version), - '__call__') as call: - client.add_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.AddSecretVersionRequest() - - -@pytest.mark.asyncio -async def test_add_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.AddSecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - )) - response = await client.add_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.AddSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_add_secret_version_async_from_dict(): - await test_add_secret_version_async(request_type=dict) - - -def test_add_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.AddSecretVersionRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - call.return_value = resources.SecretVersion() - client.add_secret_version(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_add_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.AddSecretVersionRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - await client.add_secret_version(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_add_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.add_secret_version( - parent='parent_value', - payload=resources.SecretPayload(data=b'data_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].payload == resources.SecretPayload(data=b'data_blob') - - -def test_add_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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.add_secret_version( - service.AddSecretVersionRequest(), - parent='parent_value', - payload=resources.SecretPayload(data=b'data_blob'), - ) - - -@pytest.mark.asyncio -async def test_add_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.add_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.add_secret_version( - parent='parent_value', - payload=resources.SecretPayload(data=b'data_blob'), - ) - - # 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].payload == resources.SecretPayload(data=b'data_blob') - - -@pytest.mark.asyncio -async def test_add_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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.add_secret_version( - service.AddSecretVersionRequest(), - parent='parent_value', - payload=resources.SecretPayload(data=b'data_blob'), - ) - - -def test_get_secret(transport: str = 'grpc', request_type=service.GetSecretRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret( - name='name_value', - etag='etag_value', - expire_time=timestamp_pb2.Timestamp(seconds=751), - ) - response = client.get_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -def test_get_secret_from_dict(): - test_get_secret(request_type=dict) - - -def test_get_secret_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 = SecretManagerServiceClient( - 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_secret), - '__call__') as call: - client.get_secret() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretRequest() - - -@pytest.mark.asyncio -async def test_get_secret_async(transport: str = 'grpc_asyncio', request_type=service.GetSecretRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( - name='name_value', - etag='etag_value', - )) - response = await client.get_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_secret_async_from_dict(): - await test_get_secret_async(request_type=dict) - - -def test_get_secret_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.GetSecretRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret), - '__call__') as call: - call.return_value = resources.Secret() - client.get_secret(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_secret_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.GetSecretRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - await client.get_secret(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_secret_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_secret( - 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_secret_flattened_error(): - client = SecretManagerServiceClient( - 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_secret( - service.GetSecretRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_secret_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_secret( - 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_secret_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret( - service.GetSecretRequest(), - name='name_value', - ) - - -def test_update_secret(transport: str = 'grpc', request_type=service.UpdateSecretRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret( - name='name_value', - etag='etag_value', - expire_time=timestamp_pb2.Timestamp(seconds=751), - ) - response = client.update_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -def test_update_secret_from_dict(): - test_update_secret(request_type=dict) - - -def test_update_secret_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 = SecretManagerServiceClient( - 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_secret), - '__call__') as call: - client.update_secret() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateSecretRequest() - - -@pytest.mark.asyncio -async def test_update_secret_async(transport: str = 'grpc_asyncio', request_type=service.UpdateSecretRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret( - name='name_value', - etag='etag_value', - )) - response = await client.update_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateSecretRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.Secret) - assert response.name == 'name_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_update_secret_async_from_dict(): - await test_update_secret_async(request_type=dict) - - -def test_update_secret_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.UpdateSecretRequest() - - request.secret.name = 'secret.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_secret), - '__call__') as call: - call.return_value = resources.Secret() - client.update_secret(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', - 'secret.name=secret.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_secret_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.UpdateSecretRequest() - - request.secret.name = 'secret.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_secret), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - await client.update_secret(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', - 'secret.name=secret.name/value', - ) in kw['metadata'] - - -def test_update_secret_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_secret( - secret=resources.Secret(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].secret == resources.Secret(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_secret_flattened_error(): - client = SecretManagerServiceClient( - 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_secret( - service.UpdateSecretRequest(), - secret=resources.Secret(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_secret_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.Secret() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.Secret()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_secret( - secret=resources.Secret(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].secret == resources.Secret(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_secret_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret( - service.UpdateSecretRequest(), - secret=resources.Secret(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_secret(transport: str = 'grpc', request_type=service.DeleteSecretRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteSecretRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_secret_from_dict(): - test_delete_secret(request_type=dict) - - -def test_delete_secret_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 = SecretManagerServiceClient( - 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_secret), - '__call__') as call: - client.delete_secret() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteSecretRequest() - - -@pytest.mark.asyncio -async def test_delete_secret_async(transport: str = 'grpc_asyncio', request_type=service.DeleteSecretRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_secret(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteSecretRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_secret_async_from_dict(): - await test_delete_secret_async(request_type=dict) - - -def test_delete_secret_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DeleteSecretRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_secret), - '__call__') as call: - call.return_value = None - client.delete_secret(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_secret_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DeleteSecretRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_secret), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_secret(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_secret_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_secret), - '__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_secret( - 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_secret_flattened_error(): - client = SecretManagerServiceClient( - 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_secret( - service.DeleteSecretRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_secret_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_secret), - '__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_secret( - 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_secret_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret( - service.DeleteSecretRequest(), - name='name_value', - ) - - -def test_list_secret_versions(transport: str = 'grpc', request_type=service.ListSecretVersionsRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret_versions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretVersionsResponse( - next_page_token='next_page_token_value', - total_size=1086, - ) - response = client.list_secret_versions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretVersionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSecretVersionsPager) - assert response.next_page_token == 'next_page_token_value' - assert response.total_size == 1086 - - -def test_list_secret_versions_from_dict(): - test_list_secret_versions(request_type=dict) - - -def test_list_secret_versions_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 = SecretManagerServiceClient( - 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_secret_versions), - '__call__') as call: - client.list_secret_versions() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretVersionsRequest() - - -@pytest.mark.asyncio -async def test_list_secret_versions_async(transport: str = 'grpc_asyncio', request_type=service.ListSecretVersionsRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret_versions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse( - next_page_token='next_page_token_value', - total_size=1086, - )) - response = await client.list_secret_versions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListSecretVersionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSecretVersionsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - assert response.total_size == 1086 - - -@pytest.mark.asyncio -async def test_list_secret_versions_async_from_dict(): - await test_list_secret_versions_async(request_type=dict) - - -def test_list_secret_versions_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.ListSecretVersionsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - call.return_value = service.ListSecretVersionsResponse() - client.list_secret_versions(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_secret_versions_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.ListSecretVersionsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse()) - await client.list_secret_versions(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_secret_versions_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretVersionsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_secret_versions( - 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_secret_versions_flattened_error(): - client = SecretManagerServiceClient( - 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_secret_versions( - service.ListSecretVersionsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_secret_versions_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListSecretVersionsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListSecretVersionsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_secret_versions( - 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_secret_versions_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret_versions( - service.ListSecretVersionsRequest(), - parent='parent_value', - ) - - -def test_list_secret_versions_pager(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - resources.SecretVersion(), - ], - next_page_token='abc', - ), - service.ListSecretVersionsResponse( - versions=[], - next_page_token='def', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - ], - next_page_token='ghi', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_secret_versions(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, resources.SecretVersion) - for i in results) - -def test_list_secret_versions_pages(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - resources.SecretVersion(), - ], - next_page_token='abc', - ), - service.ListSecretVersionsResponse( - versions=[], - next_page_token='def', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - ], - next_page_token='ghi', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - ], - ), - RuntimeError, - ) - pages = list(client.list_secret_versions(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_secret_versions_async_pager(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - resources.SecretVersion(), - ], - next_page_token='abc', - ), - service.ListSecretVersionsResponse( - versions=[], - next_page_token='def', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - ], - next_page_token='ghi', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_secret_versions(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, resources.SecretVersion) - for i in responses) - -@pytest.mark.asyncio -async def test_list_secret_versions_async_pages(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_secret_versions), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - resources.SecretVersion(), - ], - next_page_token='abc', - ), - service.ListSecretVersionsResponse( - versions=[], - next_page_token='def', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - ], - next_page_token='ghi', - ), - service.ListSecretVersionsResponse( - versions=[ - resources.SecretVersion(), - resources.SecretVersion(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_secret_versions(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_secret_version(transport: str = 'grpc', request_type=service.GetSecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - ) - response = client.get_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -def test_get_secret_version_from_dict(): - test_get_secret_version(request_type=dict) - - -def test_get_secret_version_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 = SecretManagerServiceClient( - 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_secret_version), - '__call__') as call: - client.get_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretVersionRequest() - - -@pytest.mark.asyncio -async def test_get_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.GetSecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - )) - response = await client.get_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_secret_version_async_from_dict(): - await test_get_secret_version_async(request_type=dict) - - -def test_get_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.GetSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret_version), - '__call__') as call: - call.return_value = resources.SecretVersion() - client.get_secret_version(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_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.GetSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - await client.get_secret_version(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_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_secret_version( - 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_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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_secret_version( - service.GetSecretVersionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_secret_version( - 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_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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_secret_version( - service.GetSecretVersionRequest(), - name='name_value', - ) - - -def test_access_secret_version(transport: str = 'grpc', request_type=service.AccessSecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.AccessSecretVersionResponse( - name='name_value', - ) - response = client.access_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.AccessSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.AccessSecretVersionResponse) - assert response.name == 'name_value' - - -def test_access_secret_version_from_dict(): - test_access_secret_version(request_type=dict) - - -def test_access_secret_version_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 = SecretManagerServiceClient( - 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.access_secret_version), - '__call__') as call: - client.access_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.AccessSecretVersionRequest() - - -@pytest.mark.asyncio -async def test_access_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.AccessSecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse( - name='name_value', - )) - response = await client.access_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.AccessSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.AccessSecretVersionResponse) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_access_secret_version_async_from_dict(): - await test_access_secret_version_async(request_type=dict) - - -def test_access_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.AccessSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - call.return_value = service.AccessSecretVersionResponse() - client.access_secret_version(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_access_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.AccessSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse()) - await client.access_secret_version(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_access_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.AccessSecretVersionResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.access_secret_version( - 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_access_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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.access_secret_version( - service.AccessSecretVersionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_access_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.access_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.AccessSecretVersionResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.AccessSecretVersionResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.access_secret_version( - 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_access_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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.access_secret_version( - service.AccessSecretVersionRequest(), - name='name_value', - ) - - -def test_disable_secret_version(transport: str = 'grpc', request_type=service.DisableSecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - ) - response = client.disable_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.DisableSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -def test_disable_secret_version_from_dict(): - test_disable_secret_version(request_type=dict) - - -def test_disable_secret_version_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 = SecretManagerServiceClient( - 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.disable_secret_version), - '__call__') as call: - client.disable_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.DisableSecretVersionRequest() - - -@pytest.mark.asyncio -async def test_disable_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.DisableSecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - )) - response = await client.disable_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.DisableSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_disable_secret_version_async_from_dict(): - await test_disable_secret_version_async(request_type=dict) - - -def test_disable_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DisableSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - call.return_value = resources.SecretVersion() - client.disable_secret_version(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_disable_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DisableSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - await client.disable_secret_version(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_disable_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.disable_secret_version( - 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_disable_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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.disable_secret_version( - service.DisableSecretVersionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_disable_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.disable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.disable_secret_version( - 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_disable_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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.disable_secret_version( - service.DisableSecretVersionRequest(), - name='name_value', - ) - - -def test_enable_secret_version(transport: str = 'grpc', request_type=service.EnableSecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - ) - response = client.enable_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.EnableSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -def test_enable_secret_version_from_dict(): - test_enable_secret_version(request_type=dict) - - -def test_enable_secret_version_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 = SecretManagerServiceClient( - 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.enable_secret_version), - '__call__') as call: - client.enable_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.EnableSecretVersionRequest() - - -@pytest.mark.asyncio -async def test_enable_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.EnableSecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - )) - response = await client.enable_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.EnableSecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_enable_secret_version_async_from_dict(): - await test_enable_secret_version_async(request_type=dict) - - -def test_enable_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.EnableSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - call.return_value = resources.SecretVersion() - client.enable_secret_version(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_enable_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.EnableSecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - await client.enable_secret_version(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_enable_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.enable_secret_version( - 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_enable_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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.enable_secret_version( - service.EnableSecretVersionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_enable_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.enable_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.enable_secret_version( - 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_enable_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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.enable_secret_version( - service.EnableSecretVersionRequest(), - name='name_value', - ) - - -def test_destroy_secret_version(transport: str = 'grpc', request_type=service.DestroySecretVersionRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - ) - response = client.destroy_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.DestroySecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -def test_destroy_secret_version_from_dict(): - test_destroy_secret_version(request_type=dict) - - -def test_destroy_secret_version_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 = SecretManagerServiceClient( - 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.destroy_secret_version), - '__call__') as call: - client.destroy_secret_version() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.DestroySecretVersionRequest() - - -@pytest.mark.asyncio -async def test_destroy_secret_version_async(transport: str = 'grpc_asyncio', request_type=service.DestroySecretVersionRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion( - name='name_value', - state=resources.SecretVersion.State.ENABLED, - etag='etag_value', - )) - response = await client.destroy_secret_version(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.DestroySecretVersionRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resources.SecretVersion) - assert response.name == 'name_value' - assert response.state == resources.SecretVersion.State.ENABLED - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_destroy_secret_version_async_from_dict(): - await test_destroy_secret_version_async(request_type=dict) - - -def test_destroy_secret_version_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DestroySecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - call.return_value = resources.SecretVersion() - client.destroy_secret_version(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_destroy_secret_version_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = service.DestroySecretVersionRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - await client.destroy_secret_version(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_destroy_secret_version_flattened(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.destroy_secret_version( - 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_destroy_secret_version_flattened_error(): - client = SecretManagerServiceClient( - 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.destroy_secret_version( - service.DestroySecretVersionRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_destroy_secret_version_flattened_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.destroy_secret_version), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resources.SecretVersion() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.SecretVersion()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.destroy_secret_version( - 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_destroy_secret_version_flattened_error_async(): - client = SecretManagerServiceAsyncClient( - 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.destroy_secret_version( - service.DestroySecretVersionRequest(), - name='name_value', - ) - - -def test_set_iam_policy(transport: str = 'grpc', request_type=iam_policy_pb2.SetIamPolicyRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_set_iam_policy_from_dict(): - test_set_iam_policy(request_type=dict) - - -def test_set_iam_policy_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 = SecretManagerServiceClient( - 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.set_iam_policy), - '__call__') as call: - client.set_iam_policy() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - - -@pytest.mark.asyncio -async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_set_iam_policy_async_from_dict(): - await test_set_iam_policy_async(request_type=dict) - - -def test_set_iam_policy_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_iam_policy_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - -def test_set_iam_policy_from_dict_foreign(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.set_iam_policy(request={ - 'resource': 'resource_value', - 'policy': policy_pb2.Policy(version=774), - } - ) - call.assert_called() - - -def test_get_iam_policy(transport: str = 'grpc', request_type=iam_policy_pb2.GetIamPolicyRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_get_iam_policy_from_dict(): - test_get_iam_policy(request_type=dict) - - -def test_get_iam_policy_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 = SecretManagerServiceClient( - 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_iam_policy), - '__call__') as call: - client.get_iam_policy() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - - -@pytest.mark.asyncio -async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_get_iam_policy_async_from_dict(): - await test_get_iam_policy_async(request_type=dict) - - -def test_get_iam_policy_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_iam_policy_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - -def test_get_iam_policy_from_dict_foreign(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.get_iam_policy(request={ - 'resource': 'resource_value', - 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), - } - ) - call.assert_called() - - -def test_test_iam_permissions(transport: str = 'grpc', request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - ) - response = client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -def test_test_iam_permissions_from_dict(): - test_test_iam_permissions(request_type=dict) - - -def test_test_iam_permissions_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 = SecretManagerServiceClient( - 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.test_iam_permissions), - '__call__') as call: - client.test_iam_permissions() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - - -@pytest.mark.asyncio -async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - )) - response = await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_async_from_dict(): - await test_test_iam_permissions_async(request_type=dict) - - -def test_test_iam_permissions_field_headers(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_field_headers_async(): - client = SecretManagerServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) - await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource/value', - ) in kw['metadata'] - -def test_test_iam_permissions_from_dict_foreign(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - response = client.test_iam_permissions(request={ - 'resource': 'resource_value', - 'permissions': ['permissions_value'], - } - ) - call.assert_called() - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.SecretManagerServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.SecretManagerServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SecretManagerServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.SecretManagerServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SecretManagerServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.SecretManagerServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = SecretManagerServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.SecretManagerServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.SecretManagerServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.SecretManagerServiceGrpcTransport, - transports.SecretManagerServiceGrpcAsyncIOTransport, -]) -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 = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.SecretManagerServiceGrpcTransport, - ) - -def test_secret_manager_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.SecretManagerServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_secret_manager_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.SecretManagerServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'list_secrets', - 'create_secret', - 'add_secret_version', - 'get_secret', - 'update_secret', - 'delete_secret', - 'list_secret_versions', - 'get_secret_version', - 'access_secret_version', - 'disable_secret_version', - 'enable_secret_version', - 'destroy_secret_version', - 'set_iam_policy', - 'get_iam_policy', - 'test_iam_permissions', - ) - 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_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SecretManagerServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SecretManagerServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_secret_manager_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.secretmanager_v1.services.secret_manager_service.transports.SecretManagerServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SecretManagerServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_secret_manager_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) - SecretManagerServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_secret_manager_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) - SecretManagerServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SecretManagerServiceGrpcTransport, - transports.SecretManagerServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_secret_manager_service_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SecretManagerServiceGrpcTransport, - transports.SecretManagerServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_secret_manager_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SecretManagerServiceGrpcTransport, grpc_helpers), - (transports.SecretManagerServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_secret_manager_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( - "secretmanager.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="secretmanager.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) -def test_secret_manager_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_secret_manager_service_host_no_port(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='secretmanager.googleapis.com'), - ) - assert client.transport._host == 'secretmanager.googleapis.com:443' - - -def test_secret_manager_service_host_with_port(): - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='secretmanager.googleapis.com:8000'), - ) - assert client.transport._host == 'secretmanager.googleapis.com:8000' - -def test_secret_manager_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SecretManagerServiceGrpcTransport( - 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_secret_manager_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SecretManagerServiceGrpcAsyncIOTransport( - 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.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) -def test_secret_manager_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.SecretManagerServiceGrpcTransport, transports.SecretManagerServiceGrpcAsyncIOTransport]) -def test_secret_manager_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_secret_path(): - project = "squid" - secret = "clam" - expected = "projects/{project}/secrets/{secret}".format(project=project, secret=secret, ) - actual = SecretManagerServiceClient.secret_path(project, secret) - assert expected == actual - - -def test_parse_secret_path(): - expected = { - "project": "whelk", - "secret": "octopus", - } - path = SecretManagerServiceClient.secret_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_secret_path(path) - assert expected == actual - -def test_secret_version_path(): - project = "oyster" - secret = "nudibranch" - secret_version = "cuttlefish" - expected = "projects/{project}/secrets/{secret}/versions/{secret_version}".format(project=project, secret=secret, secret_version=secret_version, ) - actual = SecretManagerServiceClient.secret_version_path(project, secret, secret_version) - assert expected == actual - - -def test_parse_secret_version_path(): - expected = { - "project": "mussel", - "secret": "winkle", - "secret_version": "nautilus", - } - path = SecretManagerServiceClient.secret_version_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_secret_version_path(path) - assert expected == actual - -def test_topic_path(): - project = "scallop" - topic = "abalone" - expected = "projects/{project}/topics/{topic}".format(project=project, topic=topic, ) - actual = SecretManagerServiceClient.topic_path(project, topic) - assert expected == actual - - -def test_parse_topic_path(): - expected = { - "project": "squid", - "topic": "clam", - } - path = SecretManagerServiceClient.topic_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_topic_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "whelk" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = SecretManagerServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "octopus", - } - path = SecretManagerServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "oyster" - expected = "folders/{folder}".format(folder=folder, ) - actual = SecretManagerServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nudibranch", - } - path = SecretManagerServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization, ) - actual = SecretManagerServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "mussel", - } - path = SecretManagerServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "winkle" - expected = "projects/{project}".format(project=project, ) - actual = SecretManagerServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "nautilus", - } - path = SecretManagerServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "scallop" - location = "abalone" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = SecretManagerServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "squid", - "location": "clam", - } - path = SecretManagerServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = SecretManagerServiceClient.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.SecretManagerServiceTransport, '_prep_wrapped_messages') as prep: - client = SecretManagerServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.SecretManagerServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = SecretManagerServiceClient.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 = SecretManagerServiceAsyncClient( - 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 = SecretManagerServiceClient( - 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 = SecretManagerServiceClient( - 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/secretmanager_v1/test_secret_manager_service.py b/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py index 1195d7f..f9d33af 100644 --- a/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py +++ b/tests/unit/gapic/secretmanager_v1/test_secret_manager_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.secretmanager_v1.services.secret_manager_service import ( @@ -4108,6 +4109,9 @@ def test_secret_manager_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_secret_manager_service_base_transport_with_credentials_file(): @@ -4636,3 +4640,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 = SecretManagerServiceAsyncClient( + 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 = SecretManagerServiceClient( + 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 = SecretManagerServiceClient( + 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()