Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- .gitattributes +1 -0
- .venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/INSTALLER +1 -0
- .venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/LICENSE +279 -0
- .venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/METADATA +123 -0
- .venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/RECORD +16 -0
- .venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/WHEEL +4 -0
- .venv/lib/python3.11/site-packages/functorch/__init__.py +39 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +453 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/analyticshub.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/apikeys.v2.json +702 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +2130 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/baremetalsolution.v1alpha1.json +588 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +715 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/bigqueryreservation.v1alpha2.json +904 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +585 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1925 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +679 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudasset.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +1409 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +411 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +1144 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +1398 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/connectors.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/connectors.v2.json +2500 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/css.v1.json +1310 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/customsearch.v1.json +1480 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/datacatalog.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json +729 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dfareporting.v4.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/domains.v1beta1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/drive.v3.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/eventarc.v1.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +1103 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json +1293 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/groupssettings.v1.json +419 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/iam.v2.json +880 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +0 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/ids.v1.json +1074 -0
- .venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/language.v1beta1.json +1100 -0
.gitattributes
CHANGED
|
@@ -210,3 +210,4 @@ tuning-competition-baseline/.venv/lib/python3.11/site-packages/torch/_inductor/_
|
|
| 210 |
.venv/lib/python3.11/site-packages/rpds/rpds.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
| 211 |
.venv/lib/python3.11/site-packages/watchfiles/_rust_notify.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
| 212 |
.venv/lib/python3.11/site-packages/frozenlist/_frozenlist.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 210 |
.venv/lib/python3.11/site-packages/rpds/rpds.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
| 211 |
.venv/lib/python3.11/site-packages/watchfiles/_rust_notify.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
| 212 |
.venv/lib/python3.11/site-packages/frozenlist/_frozenlist.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
| 213 |
+
.venv/lib/python3.11/site-packages/uvloop/loop.cpython-311-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text
|
.venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/INSTALLER
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
pip
|
.venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/LICENSE
ADDED
|
@@ -0,0 +1,279 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
A. HISTORY OF THE SOFTWARE
|
| 2 |
+
==========================
|
| 3 |
+
|
| 4 |
+
Python was created in the early 1990s by Guido van Rossum at Stichting
|
| 5 |
+
Mathematisch Centrum (CWI, see https://www.cwi.nl) in the Netherlands
|
| 6 |
+
as a successor of a language called ABC. Guido remains Python's
|
| 7 |
+
principal author, although it includes many contributions from others.
|
| 8 |
+
|
| 9 |
+
In 1995, Guido continued his work on Python at the Corporation for
|
| 10 |
+
National Research Initiatives (CNRI, see https://www.cnri.reston.va.us)
|
| 11 |
+
in Reston, Virginia where he released several versions of the
|
| 12 |
+
software.
|
| 13 |
+
|
| 14 |
+
In May 2000, Guido and the Python core development team moved to
|
| 15 |
+
BeOpen.com to form the BeOpen PythonLabs team. In October of the same
|
| 16 |
+
year, the PythonLabs team moved to Digital Creations, which became
|
| 17 |
+
Zope Corporation. In 2001, the Python Software Foundation (PSF, see
|
| 18 |
+
https://www.python.org/psf/) was formed, a non-profit organization
|
| 19 |
+
created specifically to own Python-related Intellectual Property.
|
| 20 |
+
Zope Corporation was a sponsoring member of the PSF.
|
| 21 |
+
|
| 22 |
+
All Python releases are Open Source (see https://opensource.org for
|
| 23 |
+
the Open Source Definition). Historically, most, but not all, Python
|
| 24 |
+
releases have also been GPL-compatible; the table below summarizes
|
| 25 |
+
the various releases.
|
| 26 |
+
|
| 27 |
+
Release Derived Year Owner GPL-
|
| 28 |
+
from compatible? (1)
|
| 29 |
+
|
| 30 |
+
0.9.0 thru 1.2 1991-1995 CWI yes
|
| 31 |
+
1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
|
| 32 |
+
1.6 1.5.2 2000 CNRI no
|
| 33 |
+
2.0 1.6 2000 BeOpen.com no
|
| 34 |
+
1.6.1 1.6 2001 CNRI yes (2)
|
| 35 |
+
2.1 2.0+1.6.1 2001 PSF no
|
| 36 |
+
2.0.1 2.0+1.6.1 2001 PSF yes
|
| 37 |
+
2.1.1 2.1+2.0.1 2001 PSF yes
|
| 38 |
+
2.1.2 2.1.1 2002 PSF yes
|
| 39 |
+
2.1.3 2.1.2 2002 PSF yes
|
| 40 |
+
2.2 and above 2.1.1 2001-now PSF yes
|
| 41 |
+
|
| 42 |
+
Footnotes:
|
| 43 |
+
|
| 44 |
+
(1) GPL-compatible doesn't mean that we're distributing Python under
|
| 45 |
+
the GPL. All Python licenses, unlike the GPL, let you distribute
|
| 46 |
+
a modified version without making your changes open source. The
|
| 47 |
+
GPL-compatible licenses make it possible to combine Python with
|
| 48 |
+
other software that is released under the GPL; the others don't.
|
| 49 |
+
|
| 50 |
+
(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
|
| 51 |
+
because its license has a choice of law clause. According to
|
| 52 |
+
CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
|
| 53 |
+
is "not incompatible" with the GPL.
|
| 54 |
+
|
| 55 |
+
Thanks to the many outside volunteers who have worked under Guido's
|
| 56 |
+
direction to make these releases possible.
|
| 57 |
+
|
| 58 |
+
|
| 59 |
+
B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
|
| 60 |
+
===============================================================
|
| 61 |
+
|
| 62 |
+
Python software and documentation are licensed under the
|
| 63 |
+
Python Software Foundation License Version 2.
|
| 64 |
+
|
| 65 |
+
Starting with Python 3.8.6, examples, recipes, and other code in
|
| 66 |
+
the documentation are dual licensed under the PSF License Version 2
|
| 67 |
+
and the Zero-Clause BSD license.
|
| 68 |
+
|
| 69 |
+
Some software incorporated into Python is under different licenses.
|
| 70 |
+
The licenses are listed with code falling under that license.
|
| 71 |
+
|
| 72 |
+
|
| 73 |
+
PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
|
| 74 |
+
--------------------------------------------
|
| 75 |
+
|
| 76 |
+
1. This LICENSE AGREEMENT is between the Python Software Foundation
|
| 77 |
+
("PSF"), and the Individual or Organization ("Licensee") accessing and
|
| 78 |
+
otherwise using this software ("Python") in source or binary form and
|
| 79 |
+
its associated documentation.
|
| 80 |
+
|
| 81 |
+
2. Subject to the terms and conditions of this License Agreement, PSF hereby
|
| 82 |
+
grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
|
| 83 |
+
analyze, test, perform and/or display publicly, prepare derivative works,
|
| 84 |
+
distribute, and otherwise use Python alone or in any derivative version,
|
| 85 |
+
provided, however, that PSF's License Agreement and PSF's notice of copyright,
|
| 86 |
+
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
|
| 87 |
+
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Python Software Foundation;
|
| 88 |
+
All Rights Reserved" are retained in Python alone or in any derivative version
|
| 89 |
+
prepared by Licensee.
|
| 90 |
+
|
| 91 |
+
3. In the event Licensee prepares a derivative work that is based on
|
| 92 |
+
or incorporates Python or any part thereof, and wants to make
|
| 93 |
+
the derivative work available to others as provided herein, then
|
| 94 |
+
Licensee hereby agrees to include in any such work a brief summary of
|
| 95 |
+
the changes made to Python.
|
| 96 |
+
|
| 97 |
+
4. PSF is making Python available to Licensee on an "AS IS"
|
| 98 |
+
basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 99 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
|
| 100 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 101 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
|
| 102 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 103 |
+
|
| 104 |
+
5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
|
| 105 |
+
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
|
| 106 |
+
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
|
| 107 |
+
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 108 |
+
|
| 109 |
+
6. This License Agreement will automatically terminate upon a material
|
| 110 |
+
breach of its terms and conditions.
|
| 111 |
+
|
| 112 |
+
7. Nothing in this License Agreement shall be deemed to create any
|
| 113 |
+
relationship of agency, partnership, or joint venture between PSF and
|
| 114 |
+
Licensee. This License Agreement does not grant permission to use PSF
|
| 115 |
+
trademarks or trade name in a trademark sense to endorse or promote
|
| 116 |
+
products or services of Licensee, or any third party.
|
| 117 |
+
|
| 118 |
+
8. By copying, installing or otherwise using Python, Licensee
|
| 119 |
+
agrees to be bound by the terms and conditions of this License
|
| 120 |
+
Agreement.
|
| 121 |
+
|
| 122 |
+
|
| 123 |
+
BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
|
| 124 |
+
-------------------------------------------
|
| 125 |
+
|
| 126 |
+
BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
|
| 127 |
+
|
| 128 |
+
1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
|
| 129 |
+
office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
|
| 130 |
+
Individual or Organization ("Licensee") accessing and otherwise using
|
| 131 |
+
this software in source or binary form and its associated
|
| 132 |
+
documentation ("the Software").
|
| 133 |
+
|
| 134 |
+
2. Subject to the terms and conditions of this BeOpen Python License
|
| 135 |
+
Agreement, BeOpen hereby grants Licensee a non-exclusive,
|
| 136 |
+
royalty-free, world-wide license to reproduce, analyze, test, perform
|
| 137 |
+
and/or display publicly, prepare derivative works, distribute, and
|
| 138 |
+
otherwise use the Software alone or in any derivative version,
|
| 139 |
+
provided, however, that the BeOpen Python License is retained in the
|
| 140 |
+
Software, alone or in any derivative version prepared by Licensee.
|
| 141 |
+
|
| 142 |
+
3. BeOpen is making the Software available to Licensee on an "AS IS"
|
| 143 |
+
basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 144 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
|
| 145 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 146 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
|
| 147 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 148 |
+
|
| 149 |
+
4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
|
| 150 |
+
SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
|
| 151 |
+
AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
|
| 152 |
+
DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 153 |
+
|
| 154 |
+
5. This License Agreement will automatically terminate upon a material
|
| 155 |
+
breach of its terms and conditions.
|
| 156 |
+
|
| 157 |
+
6. This License Agreement shall be governed by and interpreted in all
|
| 158 |
+
respects by the law of the State of California, excluding conflict of
|
| 159 |
+
law provisions. Nothing in this License Agreement shall be deemed to
|
| 160 |
+
create any relationship of agency, partnership, or joint venture
|
| 161 |
+
between BeOpen and Licensee. This License Agreement does not grant
|
| 162 |
+
permission to use BeOpen trademarks or trade names in a trademark
|
| 163 |
+
sense to endorse or promote products or services of Licensee, or any
|
| 164 |
+
third party. As an exception, the "BeOpen Python" logos available at
|
| 165 |
+
http://www.pythonlabs.com/logos.html may be used according to the
|
| 166 |
+
permissions granted on that web page.
|
| 167 |
+
|
| 168 |
+
7. By copying, installing or otherwise using the software, Licensee
|
| 169 |
+
agrees to be bound by the terms and conditions of this License
|
| 170 |
+
Agreement.
|
| 171 |
+
|
| 172 |
+
|
| 173 |
+
CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
|
| 174 |
+
---------------------------------------
|
| 175 |
+
|
| 176 |
+
1. This LICENSE AGREEMENT is between the Corporation for National
|
| 177 |
+
Research Initiatives, having an office at 1895 Preston White Drive,
|
| 178 |
+
Reston, VA 20191 ("CNRI"), and the Individual or Organization
|
| 179 |
+
("Licensee") accessing and otherwise using Python 1.6.1 software in
|
| 180 |
+
source or binary form and its associated documentation.
|
| 181 |
+
|
| 182 |
+
2. Subject to the terms and conditions of this License Agreement, CNRI
|
| 183 |
+
hereby grants Licensee a nonexclusive, royalty-free, world-wide
|
| 184 |
+
license to reproduce, analyze, test, perform and/or display publicly,
|
| 185 |
+
prepare derivative works, distribute, and otherwise use Python 1.6.1
|
| 186 |
+
alone or in any derivative version, provided, however, that CNRI's
|
| 187 |
+
License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
|
| 188 |
+
1995-2001 Corporation for National Research Initiatives; All Rights
|
| 189 |
+
Reserved" are retained in Python 1.6.1 alone or in any derivative
|
| 190 |
+
version prepared by Licensee. Alternately, in lieu of CNRI's License
|
| 191 |
+
Agreement, Licensee may substitute the following text (omitting the
|
| 192 |
+
quotes): "Python 1.6.1 is made available subject to the terms and
|
| 193 |
+
conditions in CNRI's License Agreement. This Agreement together with
|
| 194 |
+
Python 1.6.1 may be located on the internet using the following
|
| 195 |
+
unique, persistent identifier (known as a handle): 1895.22/1013. This
|
| 196 |
+
Agreement may also be obtained from a proxy server on the internet
|
| 197 |
+
using the following URL: http://hdl.handle.net/1895.22/1013".
|
| 198 |
+
|
| 199 |
+
3. In the event Licensee prepares a derivative work that is based on
|
| 200 |
+
or incorporates Python 1.6.1 or any part thereof, and wants to make
|
| 201 |
+
the derivative work available to others as provided herein, then
|
| 202 |
+
Licensee hereby agrees to include in any such work a brief summary of
|
| 203 |
+
the changes made to Python 1.6.1.
|
| 204 |
+
|
| 205 |
+
4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
|
| 206 |
+
basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 207 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
|
| 208 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 209 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
|
| 210 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 211 |
+
|
| 212 |
+
5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
|
| 213 |
+
1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
|
| 214 |
+
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
|
| 215 |
+
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 216 |
+
|
| 217 |
+
6. This License Agreement will automatically terminate upon a material
|
| 218 |
+
breach of its terms and conditions.
|
| 219 |
+
|
| 220 |
+
7. This License Agreement shall be governed by the federal
|
| 221 |
+
intellectual property law of the United States, including without
|
| 222 |
+
limitation the federal copyright law, and, to the extent such
|
| 223 |
+
U.S. federal law does not apply, by the law of the Commonwealth of
|
| 224 |
+
Virginia, excluding Virginia's conflict of law provisions.
|
| 225 |
+
Notwithstanding the foregoing, with regard to derivative works based
|
| 226 |
+
on Python 1.6.1 that incorporate non-separable material that was
|
| 227 |
+
previously distributed under the GNU General Public License (GPL), the
|
| 228 |
+
law of the Commonwealth of Virginia shall govern this License
|
| 229 |
+
Agreement only as to issues arising under or with respect to
|
| 230 |
+
Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
|
| 231 |
+
License Agreement shall be deemed to create any relationship of
|
| 232 |
+
agency, partnership, or joint venture between CNRI and Licensee. This
|
| 233 |
+
License Agreement does not grant permission to use CNRI trademarks or
|
| 234 |
+
trade name in a trademark sense to endorse or promote products or
|
| 235 |
+
services of Licensee, or any third party.
|
| 236 |
+
|
| 237 |
+
8. By clicking on the "ACCEPT" button where indicated, or by copying,
|
| 238 |
+
installing or otherwise using Python 1.6.1, Licensee agrees to be
|
| 239 |
+
bound by the terms and conditions of this License Agreement.
|
| 240 |
+
|
| 241 |
+
ACCEPT
|
| 242 |
+
|
| 243 |
+
|
| 244 |
+
CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
|
| 245 |
+
--------------------------------------------------
|
| 246 |
+
|
| 247 |
+
Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
|
| 248 |
+
The Netherlands. All rights reserved.
|
| 249 |
+
|
| 250 |
+
Permission to use, copy, modify, and distribute this software and its
|
| 251 |
+
documentation for any purpose and without fee is hereby granted,
|
| 252 |
+
provided that the above copyright notice appear in all copies and that
|
| 253 |
+
both that copyright notice and this permission notice appear in
|
| 254 |
+
supporting documentation, and that the name of Stichting Mathematisch
|
| 255 |
+
Centrum or CWI not be used in advertising or publicity pertaining to
|
| 256 |
+
distribution of the software without specific, written prior
|
| 257 |
+
permission.
|
| 258 |
+
|
| 259 |
+
STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
|
| 260 |
+
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
| 261 |
+
FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
|
| 262 |
+
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
| 263 |
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
| 264 |
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
| 265 |
+
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
| 266 |
+
|
| 267 |
+
ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION
|
| 268 |
+
----------------------------------------------------------------------
|
| 269 |
+
|
| 270 |
+
Permission to use, copy, modify, and/or distribute this software for any
|
| 271 |
+
purpose with or without fee is hereby granted.
|
| 272 |
+
|
| 273 |
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
| 274 |
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
| 275 |
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
| 276 |
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
| 277 |
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
| 278 |
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
| 279 |
+
PERFORMANCE OF THIS SOFTWARE.
|
.venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/METADATA
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.3
|
| 2 |
+
Name: aiohappyeyeballs
|
| 3 |
+
Version: 2.4.6
|
| 4 |
+
Summary: Happy Eyeballs for asyncio
|
| 5 |
+
License: PSF-2.0
|
| 6 |
+
Author: J. Nick Koston
|
| 7 |
+
Author-email: nick@koston.org
|
| 8 |
+
Requires-Python: >=3.9
|
| 9 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 10 |
+
Classifier: Intended Audience :: Developers
|
| 11 |
+
Classifier: Natural Language :: English
|
| 12 |
+
Classifier: Operating System :: OS Independent
|
| 13 |
+
Classifier: Topic :: Software Development :: Libraries
|
| 14 |
+
Classifier: Programming Language :: Python :: 3
|
| 15 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 16 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 17 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 20 |
+
Classifier: License :: OSI Approved :: Python Software Foundation License
|
| 21 |
+
Project-URL: Bug Tracker, https://github.com/aio-libs/aiohappyeyeballs/issues
|
| 22 |
+
Project-URL: Changelog, https://github.com/aio-libs/aiohappyeyeballs/blob/main/CHANGELOG.md
|
| 23 |
+
Project-URL: Documentation, https://aiohappyeyeballs.readthedocs.io
|
| 24 |
+
Project-URL: Repository, https://github.com/aio-libs/aiohappyeyeballs
|
| 25 |
+
Description-Content-Type: text/markdown
|
| 26 |
+
|
| 27 |
+
# aiohappyeyeballs
|
| 28 |
+
|
| 29 |
+
<p align="center">
|
| 30 |
+
<a href="https://github.com/aio-libs/aiohappyeyeballs/actions/workflows/ci.yml?query=branch%3Amain">
|
| 31 |
+
<img src="https://img.shields.io/github/actions/workflow/status/aio-libs/aiohappyeyeballs/ci-cd.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
|
| 32 |
+
</a>
|
| 33 |
+
<a href="https://aiohappyeyeballs.readthedocs.io">
|
| 34 |
+
<img src="https://img.shields.io/readthedocs/aiohappyeyeballs.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
|
| 35 |
+
</a>
|
| 36 |
+
<a href="https://codecov.io/gh/aio-libs/aiohappyeyeballs">
|
| 37 |
+
<img src="https://img.shields.io/codecov/c/github/aio-libs/aiohappyeyeballs.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
|
| 38 |
+
</a>
|
| 39 |
+
</p>
|
| 40 |
+
<p align="center">
|
| 41 |
+
<a href="https://python-poetry.org/">
|
| 42 |
+
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
|
| 43 |
+
</a>
|
| 44 |
+
<a href="https://github.com/astral-sh/ruff">
|
| 45 |
+
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
|
| 46 |
+
</a>
|
| 47 |
+
<a href="https://github.com/pre-commit/pre-commit">
|
| 48 |
+
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
|
| 49 |
+
</a>
|
| 50 |
+
</p>
|
| 51 |
+
<p align="center">
|
| 52 |
+
<a href="https://pypi.org/project/aiohappyeyeballs/">
|
| 53 |
+
<img src="https://img.shields.io/pypi/v/aiohappyeyeballs.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
|
| 54 |
+
</a>
|
| 55 |
+
<img src="https://img.shields.io/pypi/pyversions/aiohappyeyeballs.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
|
| 56 |
+
<img src="https://img.shields.io/pypi/l/aiohappyeyeballs.svg?style=flat-square" alt="License">
|
| 57 |
+
</p>
|
| 58 |
+
|
| 59 |
+
---
|
| 60 |
+
|
| 61 |
+
**Documentation**: <a href="https://aiohappyeyeballs.readthedocs.io" target="_blank">https://aiohappyeyeballs.readthedocs.io </a>
|
| 62 |
+
|
| 63 |
+
**Source Code**: <a href="https://github.com/aio-libs/aiohappyeyeballs" target="_blank">https://github.com/aio-libs/aiohappyeyeballs </a>
|
| 64 |
+
|
| 65 |
+
---
|
| 66 |
+
|
| 67 |
+
[Happy Eyeballs](https://en.wikipedia.org/wiki/Happy_Eyeballs)
|
| 68 |
+
([RFC 8305](https://www.rfc-editor.org/rfc/rfc8305.html))
|
| 69 |
+
|
| 70 |
+
## Use case
|
| 71 |
+
|
| 72 |
+
This library exists to allow connecting with
|
| 73 |
+
[Happy Eyeballs](https://en.wikipedia.org/wiki/Happy_Eyeballs)
|
| 74 |
+
([RFC 8305](https://www.rfc-editor.org/rfc/rfc8305.html))
|
| 75 |
+
when you
|
| 76 |
+
already have a list of addrinfo and not a DNS name.
|
| 77 |
+
|
| 78 |
+
The stdlib version of `loop.create_connection()`
|
| 79 |
+
will only work when you pass in an unresolved name which
|
| 80 |
+
is not a good fit when using DNS caching or resolving
|
| 81 |
+
names via another method such as `zeroconf`.
|
| 82 |
+
|
| 83 |
+
## Installation
|
| 84 |
+
|
| 85 |
+
Install this via pip (or your favourite package manager):
|
| 86 |
+
|
| 87 |
+
`pip install aiohappyeyeballs`
|
| 88 |
+
|
| 89 |
+
## License
|
| 90 |
+
|
| 91 |
+
[aiohappyeyeballs is licensed under the same terms as cpython itself.](https://github.com/python/cpython/blob/main/LICENSE)
|
| 92 |
+
|
| 93 |
+
## Example usage
|
| 94 |
+
|
| 95 |
+
```python
|
| 96 |
+
|
| 97 |
+
addr_infos = await loop.getaddrinfo("example.org", 80)
|
| 98 |
+
|
| 99 |
+
socket = await start_connection(addr_infos)
|
| 100 |
+
socket = await start_connection(addr_infos, local_addr_infos=local_addr_infos, happy_eyeballs_delay=0.2)
|
| 101 |
+
|
| 102 |
+
transport, protocol = await loop.create_connection(
|
| 103 |
+
MyProtocol, sock=socket, ...)
|
| 104 |
+
|
| 105 |
+
# Remove the first address for each family from addr_info
|
| 106 |
+
pop_addr_infos_interleave(addr_info, 1)
|
| 107 |
+
|
| 108 |
+
# Remove all matching address from addr_info
|
| 109 |
+
remove_addr_infos(addr_info, "dead::beef::")
|
| 110 |
+
|
| 111 |
+
# Convert a local_addr to local_addr_infos
|
| 112 |
+
local_addr_infos = addr_to_addr_infos(("127.0.0.1",0))
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
## Credits
|
| 116 |
+
|
| 117 |
+
This package contains code from cpython and is licensed under the same terms as cpython itself.
|
| 118 |
+
|
| 119 |
+
This package was created with
|
| 120 |
+
[Copier](https://copier.readthedocs.io/) and the
|
| 121 |
+
[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
|
| 122 |
+
project template.
|
| 123 |
+
|
.venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/RECORD
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
aiohappyeyeballs-2.4.6.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
| 2 |
+
aiohappyeyeballs-2.4.6.dist-info/LICENSE,sha256=Oy-B_iHRgcSZxZolbI4ZaEVdZonSaaqFNzv7avQdo78,13936
|
| 3 |
+
aiohappyeyeballs-2.4.6.dist-info/METADATA,sha256=57Lz5EDHk7TF4Oax_XNbrYyA2yOXTb2j22mOZd-uqaM,5915
|
| 4 |
+
aiohappyeyeballs-2.4.6.dist-info/RECORD,,
|
| 5 |
+
aiohappyeyeballs-2.4.6.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
|
| 6 |
+
aiohappyeyeballs/__init__.py,sha256=BQdrvCrl9sfn8i_nyFHBMBtWSImRkHB0hnuKzuxBR_U,317
|
| 7 |
+
aiohappyeyeballs/__pycache__/__init__.cpython-311.pyc,,
|
| 8 |
+
aiohappyeyeballs/__pycache__/_staggered.cpython-311.pyc,,
|
| 9 |
+
aiohappyeyeballs/__pycache__/impl.cpython-311.pyc,,
|
| 10 |
+
aiohappyeyeballs/__pycache__/types.cpython-311.pyc,,
|
| 11 |
+
aiohappyeyeballs/__pycache__/utils.cpython-311.pyc,,
|
| 12 |
+
aiohappyeyeballs/_staggered.py,sha256=EJffJ9VcZ8pTrnYGwbEk03dGlKhumkznvAi0xSEQmEA,6737
|
| 13 |
+
aiohappyeyeballs/impl.py,sha256=dad76ssTB0hlJagDdi7_wtKH57RJrWpxDzDQv3EfyIM,7708
|
| 14 |
+
aiohappyeyeballs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
| 15 |
+
aiohappyeyeballs/types.py,sha256=iYPiBTl5J7YEjnIqEOVUTRPzz2DwqSHBRhvbAlM0zv0,234
|
| 16 |
+
aiohappyeyeballs/utils.py,sha256=on9GxIR0LhEfZu8P6Twi9hepX9zDanuZM20MWsb3xlQ,3028
|
.venv/lib/python3.11/site-packages/aiohappyeyeballs-2.4.6.dist-info/WHEEL
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Wheel-Version: 1.0
|
| 2 |
+
Generator: poetry-core 2.0.1
|
| 3 |
+
Root-Is-Purelib: true
|
| 4 |
+
Tag: py3-none-any
|
.venv/lib/python3.11/site-packages/functorch/__init__.py
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Copyright (c) Facebook, Inc. and its affiliates.
|
| 2 |
+
# All rights reserved.
|
| 3 |
+
#
|
| 4 |
+
# This source code is licensed under the BSD-style license found in the
|
| 5 |
+
# LICENSE file in the root directory of this source tree.
|
| 6 |
+
import torch
|
| 7 |
+
from torch._functorch.deprecated import (
|
| 8 |
+
combine_state_for_ensemble,
|
| 9 |
+
functionalize,
|
| 10 |
+
grad,
|
| 11 |
+
grad_and_value,
|
| 12 |
+
hessian,
|
| 13 |
+
jacfwd,
|
| 14 |
+
jacrev,
|
| 15 |
+
jvp,
|
| 16 |
+
make_functional,
|
| 17 |
+
make_functional_with_buffers,
|
| 18 |
+
vjp,
|
| 19 |
+
vmap,
|
| 20 |
+
)
|
| 21 |
+
|
| 22 |
+
# utilities. Maybe these should go in their own namespace in the future?
|
| 23 |
+
from torch._functorch.make_functional import (
|
| 24 |
+
FunctionalModule,
|
| 25 |
+
FunctionalModuleWithBuffers,
|
| 26 |
+
)
|
| 27 |
+
|
| 28 |
+
# Was never documented
|
| 29 |
+
from torch._functorch.python_key import make_fx
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
# Top-level APIs. Please think carefully before adding something to the
|
| 33 |
+
# top-level namespace:
|
| 34 |
+
# - private helper functions should go into torch._functorch
|
| 35 |
+
# - very experimental things should go into functorch.experimental
|
| 36 |
+
# - compilation related things should go into functorch.compile
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
__version__ = torch.__version__
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json
ADDED
|
@@ -0,0 +1,453 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/admin.datatransfer": {
|
| 6 |
+
"description": "View and manage data transfers between users in your organization"
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/admin.datatransfer.readonly": {
|
| 9 |
+
"description": "View data transfers between users in your organization"
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://admin.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "DataTransfer",
|
| 18 |
+
"description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://developers.google.com/admin-sdk/",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "admin:datatransfer_v1",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://admin.mtls.googleapis.com/",
|
| 29 |
+
"name": "admin",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"packagePath": "admin",
|
| 33 |
+
"parameters": {
|
| 34 |
+
"$.xgafv": {
|
| 35 |
+
"description": "V1 error format.",
|
| 36 |
+
"enum": [
|
| 37 |
+
"1",
|
| 38 |
+
"2"
|
| 39 |
+
],
|
| 40 |
+
"enumDescriptions": [
|
| 41 |
+
"v1 error format",
|
| 42 |
+
"v2 error format"
|
| 43 |
+
],
|
| 44 |
+
"location": "query",
|
| 45 |
+
"type": "string"
|
| 46 |
+
},
|
| 47 |
+
"access_token": {
|
| 48 |
+
"description": "OAuth access token.",
|
| 49 |
+
"location": "query",
|
| 50 |
+
"type": "string"
|
| 51 |
+
},
|
| 52 |
+
"alt": {
|
| 53 |
+
"default": "json",
|
| 54 |
+
"description": "Data format for response.",
|
| 55 |
+
"enum": [
|
| 56 |
+
"json",
|
| 57 |
+
"media",
|
| 58 |
+
"proto"
|
| 59 |
+
],
|
| 60 |
+
"enumDescriptions": [
|
| 61 |
+
"Responses with Content-Type of application/json",
|
| 62 |
+
"Media download with context-dependent Content-Type",
|
| 63 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 64 |
+
],
|
| 65 |
+
"location": "query",
|
| 66 |
+
"type": "string"
|
| 67 |
+
},
|
| 68 |
+
"callback": {
|
| 69 |
+
"description": "JSONP",
|
| 70 |
+
"location": "query",
|
| 71 |
+
"type": "string"
|
| 72 |
+
},
|
| 73 |
+
"fields": {
|
| 74 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 75 |
+
"location": "query",
|
| 76 |
+
"type": "string"
|
| 77 |
+
},
|
| 78 |
+
"key": {
|
| 79 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 80 |
+
"location": "query",
|
| 81 |
+
"type": "string"
|
| 82 |
+
},
|
| 83 |
+
"oauth_token": {
|
| 84 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 85 |
+
"location": "query",
|
| 86 |
+
"type": "string"
|
| 87 |
+
},
|
| 88 |
+
"prettyPrint": {
|
| 89 |
+
"default": "true",
|
| 90 |
+
"description": "Returns response with indentations and line breaks.",
|
| 91 |
+
"location": "query",
|
| 92 |
+
"type": "boolean"
|
| 93 |
+
},
|
| 94 |
+
"quotaUser": {
|
| 95 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 96 |
+
"location": "query",
|
| 97 |
+
"type": "string"
|
| 98 |
+
},
|
| 99 |
+
"uploadType": {
|
| 100 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 101 |
+
"location": "query",
|
| 102 |
+
"type": "string"
|
| 103 |
+
},
|
| 104 |
+
"upload_protocol": {
|
| 105 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 106 |
+
"location": "query",
|
| 107 |
+
"type": "string"
|
| 108 |
+
}
|
| 109 |
+
},
|
| 110 |
+
"protocol": "rest",
|
| 111 |
+
"resources": {
|
| 112 |
+
"applications": {
|
| 113 |
+
"methods": {
|
| 114 |
+
"get": {
|
| 115 |
+
"description": "Retrieves information about an application for the given application ID.",
|
| 116 |
+
"flatPath": "admin/datatransfer/v1/applications/{applicationId}",
|
| 117 |
+
"httpMethod": "GET",
|
| 118 |
+
"id": "datatransfer.applications.get",
|
| 119 |
+
"parameterOrder": [
|
| 120 |
+
"applicationId"
|
| 121 |
+
],
|
| 122 |
+
"parameters": {
|
| 123 |
+
"applicationId": {
|
| 124 |
+
"description": "ID of the application resource to be retrieved.",
|
| 125 |
+
"format": "int64",
|
| 126 |
+
"location": "path",
|
| 127 |
+
"required": true,
|
| 128 |
+
"type": "string"
|
| 129 |
+
}
|
| 130 |
+
},
|
| 131 |
+
"path": "admin/datatransfer/v1/applications/{applicationId}",
|
| 132 |
+
"response": {
|
| 133 |
+
"$ref": "Application"
|
| 134 |
+
},
|
| 135 |
+
"scopes": [
|
| 136 |
+
"https://www.googleapis.com/auth/admin.datatransfer",
|
| 137 |
+
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
|
| 138 |
+
]
|
| 139 |
+
},
|
| 140 |
+
"list": {
|
| 141 |
+
"description": "Lists the applications available for data transfer for a customer.",
|
| 142 |
+
"flatPath": "admin/datatransfer/v1/applications",
|
| 143 |
+
"httpMethod": "GET",
|
| 144 |
+
"id": "datatransfer.applications.list",
|
| 145 |
+
"parameterOrder": [],
|
| 146 |
+
"parameters": {
|
| 147 |
+
"customerId": {
|
| 148 |
+
"description": "Immutable ID of the Google Workspace account.",
|
| 149 |
+
"location": "query",
|
| 150 |
+
"type": "string"
|
| 151 |
+
},
|
| 152 |
+
"maxResults": {
|
| 153 |
+
"description": "Maximum number of results to return. Default is 100.",
|
| 154 |
+
"format": "int32",
|
| 155 |
+
"location": "query",
|
| 156 |
+
"maximum": "500",
|
| 157 |
+
"minimum": "1",
|
| 158 |
+
"type": "integer"
|
| 159 |
+
},
|
| 160 |
+
"pageToken": {
|
| 161 |
+
"description": "Token to specify next page in the list.",
|
| 162 |
+
"location": "query",
|
| 163 |
+
"type": "string"
|
| 164 |
+
}
|
| 165 |
+
},
|
| 166 |
+
"path": "admin/datatransfer/v1/applications",
|
| 167 |
+
"response": {
|
| 168 |
+
"$ref": "ApplicationsListResponse"
|
| 169 |
+
},
|
| 170 |
+
"scopes": [
|
| 171 |
+
"https://www.googleapis.com/auth/admin.datatransfer",
|
| 172 |
+
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
|
| 173 |
+
]
|
| 174 |
+
}
|
| 175 |
+
}
|
| 176 |
+
},
|
| 177 |
+
"transfers": {
|
| 178 |
+
"methods": {
|
| 179 |
+
"get": {
|
| 180 |
+
"description": "Retrieves a data transfer request by its resource ID.",
|
| 181 |
+
"flatPath": "admin/datatransfer/v1/transfers/{dataTransferId}",
|
| 182 |
+
"httpMethod": "GET",
|
| 183 |
+
"id": "datatransfer.transfers.get",
|
| 184 |
+
"parameterOrder": [
|
| 185 |
+
"dataTransferId"
|
| 186 |
+
],
|
| 187 |
+
"parameters": {
|
| 188 |
+
"dataTransferId": {
|
| 189 |
+
"description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
|
| 190 |
+
"location": "path",
|
| 191 |
+
"required": true,
|
| 192 |
+
"type": "string"
|
| 193 |
+
}
|
| 194 |
+
},
|
| 195 |
+
"path": "admin/datatransfer/v1/transfers/{dataTransferId}",
|
| 196 |
+
"response": {
|
| 197 |
+
"$ref": "DataTransfer"
|
| 198 |
+
},
|
| 199 |
+
"scopes": [
|
| 200 |
+
"https://www.googleapis.com/auth/admin.datatransfer",
|
| 201 |
+
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
|
| 202 |
+
]
|
| 203 |
+
},
|
| 204 |
+
"insert": {
|
| 205 |
+
"description": "Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.",
|
| 206 |
+
"flatPath": "admin/datatransfer/v1/transfers",
|
| 207 |
+
"httpMethod": "POST",
|
| 208 |
+
"id": "datatransfer.transfers.insert",
|
| 209 |
+
"parameterOrder": [],
|
| 210 |
+
"parameters": {},
|
| 211 |
+
"path": "admin/datatransfer/v1/transfers",
|
| 212 |
+
"request": {
|
| 213 |
+
"$ref": "DataTransfer"
|
| 214 |
+
},
|
| 215 |
+
"response": {
|
| 216 |
+
"$ref": "DataTransfer"
|
| 217 |
+
},
|
| 218 |
+
"scopes": [
|
| 219 |
+
"https://www.googleapis.com/auth/admin.datatransfer"
|
| 220 |
+
]
|
| 221 |
+
},
|
| 222 |
+
"list": {
|
| 223 |
+
"description": "Lists the transfers for a customer by source user, destination user, or status.",
|
| 224 |
+
"flatPath": "admin/datatransfer/v1/transfers",
|
| 225 |
+
"httpMethod": "GET",
|
| 226 |
+
"id": "datatransfer.transfers.list",
|
| 227 |
+
"parameterOrder": [],
|
| 228 |
+
"parameters": {
|
| 229 |
+
"customerId": {
|
| 230 |
+
"description": "Immutable ID of the Google Workspace account.",
|
| 231 |
+
"location": "query",
|
| 232 |
+
"type": "string"
|
| 233 |
+
},
|
| 234 |
+
"maxResults": {
|
| 235 |
+
"description": "Maximum number of results to return. Default is 100.",
|
| 236 |
+
"format": "int32",
|
| 237 |
+
"location": "query",
|
| 238 |
+
"maximum": "500",
|
| 239 |
+
"minimum": "1",
|
| 240 |
+
"type": "integer"
|
| 241 |
+
},
|
| 242 |
+
"newOwnerUserId": {
|
| 243 |
+
"description": "Destination user's profile ID.",
|
| 244 |
+
"location": "query",
|
| 245 |
+
"type": "string"
|
| 246 |
+
},
|
| 247 |
+
"oldOwnerUserId": {
|
| 248 |
+
"description": "Source user's profile ID.",
|
| 249 |
+
"location": "query",
|
| 250 |
+
"type": "string"
|
| 251 |
+
},
|
| 252 |
+
"pageToken": {
|
| 253 |
+
"description": "Token to specify the next page in the list.",
|
| 254 |
+
"location": "query",
|
| 255 |
+
"type": "string"
|
| 256 |
+
},
|
| 257 |
+
"status": {
|
| 258 |
+
"description": "Status of the transfer.",
|
| 259 |
+
"location": "query",
|
| 260 |
+
"type": "string"
|
| 261 |
+
}
|
| 262 |
+
},
|
| 263 |
+
"path": "admin/datatransfer/v1/transfers",
|
| 264 |
+
"response": {
|
| 265 |
+
"$ref": "DataTransfersListResponse"
|
| 266 |
+
},
|
| 267 |
+
"scopes": [
|
| 268 |
+
"https://www.googleapis.com/auth/admin.datatransfer",
|
| 269 |
+
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
|
| 270 |
+
]
|
| 271 |
+
}
|
| 272 |
+
}
|
| 273 |
+
}
|
| 274 |
+
},
|
| 275 |
+
"revision": "20240618",
|
| 276 |
+
"rootUrl": "https://admin.googleapis.com/",
|
| 277 |
+
"schemas": {
|
| 278 |
+
"Application": {
|
| 279 |
+
"description": "Application resources represent applications installed on the domain that support transferring ownership of user data.",
|
| 280 |
+
"id": "Application",
|
| 281 |
+
"properties": {
|
| 282 |
+
"etag": {
|
| 283 |
+
"description": "Etag of the resource.",
|
| 284 |
+
"type": "string"
|
| 285 |
+
},
|
| 286 |
+
"id": {
|
| 287 |
+
"description": "The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.",
|
| 288 |
+
"format": "int64",
|
| 289 |
+
"type": "string"
|
| 290 |
+
},
|
| 291 |
+
"kind": {
|
| 292 |
+
"default": "admin#datatransfer#ApplicationResource",
|
| 293 |
+
"description": "Identifies the resource as a DataTransfer Application Resource.",
|
| 294 |
+
"type": "string"
|
| 295 |
+
},
|
| 296 |
+
"name": {
|
| 297 |
+
"description": "The application's name.",
|
| 298 |
+
"type": "string"
|
| 299 |
+
},
|
| 300 |
+
"transferParams": {
|
| 301 |
+
"description": "The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.",
|
| 302 |
+
"items": {
|
| 303 |
+
"$ref": "ApplicationTransferParam"
|
| 304 |
+
},
|
| 305 |
+
"type": "array"
|
| 306 |
+
}
|
| 307 |
+
},
|
| 308 |
+
"type": "object"
|
| 309 |
+
},
|
| 310 |
+
"ApplicationDataTransfer": {
|
| 311 |
+
"description": "Template to map fields of ApplicationDataTransfer resource.",
|
| 312 |
+
"id": "ApplicationDataTransfer",
|
| 313 |
+
"properties": {
|
| 314 |
+
"applicationId": {
|
| 315 |
+
"description": "The application's ID.",
|
| 316 |
+
"format": "int64",
|
| 317 |
+
"type": "string"
|
| 318 |
+
},
|
| 319 |
+
"applicationTransferParams": {
|
| 320 |
+
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.",
|
| 321 |
+
"items": {
|
| 322 |
+
"$ref": "ApplicationTransferParam"
|
| 323 |
+
},
|
| 324 |
+
"type": "array"
|
| 325 |
+
},
|
| 326 |
+
"applicationTransferStatus": {
|
| 327 |
+
"description": "Read-only. Current status of transfer for this application.",
|
| 328 |
+
"type": "string"
|
| 329 |
+
}
|
| 330 |
+
},
|
| 331 |
+
"type": "object"
|
| 332 |
+
},
|
| 333 |
+
"ApplicationTransferParam": {
|
| 334 |
+
"description": "Template for application transfer parameters.",
|
| 335 |
+
"id": "ApplicationTransferParam",
|
| 336 |
+
"properties": {
|
| 337 |
+
"key": {
|
| 338 |
+
"description": "The type of the transfer parameter, such as `PRIVACY_LEVEL`.",
|
| 339 |
+
"type": "string"
|
| 340 |
+
},
|
| 341 |
+
"value": {
|
| 342 |
+
"description": "The value of the transfer parameter, such as `PRIVATE` or `SHARED`.",
|
| 343 |
+
"items": {
|
| 344 |
+
"type": "string"
|
| 345 |
+
},
|
| 346 |
+
"type": "array"
|
| 347 |
+
}
|
| 348 |
+
},
|
| 349 |
+
"type": "object"
|
| 350 |
+
},
|
| 351 |
+
"ApplicationsListResponse": {
|
| 352 |
+
"description": "Template for a collection of Applications.",
|
| 353 |
+
"id": "ApplicationsListResponse",
|
| 354 |
+
"properties": {
|
| 355 |
+
"applications": {
|
| 356 |
+
"description": "The list of applications that support data transfer and are also installed for the customer.",
|
| 357 |
+
"items": {
|
| 358 |
+
"$ref": "Application"
|
| 359 |
+
},
|
| 360 |
+
"type": "array"
|
| 361 |
+
},
|
| 362 |
+
"etag": {
|
| 363 |
+
"description": "ETag of the resource.",
|
| 364 |
+
"type": "string"
|
| 365 |
+
},
|
| 366 |
+
"kind": {
|
| 367 |
+
"default": "admin#datatransfer#applicationsList",
|
| 368 |
+
"description": "Identifies the resource as a collection of Applications.",
|
| 369 |
+
"type": "string"
|
| 370 |
+
},
|
| 371 |
+
"nextPageToken": {
|
| 372 |
+
"description": "Token to specify the next page in the list.",
|
| 373 |
+
"type": "string"
|
| 374 |
+
}
|
| 375 |
+
},
|
| 376 |
+
"type": "object"
|
| 377 |
+
},
|
| 378 |
+
"DataTransfer": {
|
| 379 |
+
"description": "A Transfer resource represents the transfer of the ownership of user data between users.",
|
| 380 |
+
"id": "DataTransfer",
|
| 381 |
+
"properties": {
|
| 382 |
+
"applicationDataTransfers": {
|
| 383 |
+
"description": "The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.",
|
| 384 |
+
"items": {
|
| 385 |
+
"$ref": "ApplicationDataTransfer"
|
| 386 |
+
},
|
| 387 |
+
"type": "array"
|
| 388 |
+
},
|
| 389 |
+
"etag": {
|
| 390 |
+
"description": "ETag of the resource.",
|
| 391 |
+
"type": "string"
|
| 392 |
+
},
|
| 393 |
+
"id": {
|
| 394 |
+
"description": "Read-only. The transfer's ID.",
|
| 395 |
+
"type": "string"
|
| 396 |
+
},
|
| 397 |
+
"kind": {
|
| 398 |
+
"default": "admin#datatransfer#DataTransfer",
|
| 399 |
+
"description": "Identifies the resource as a DataTransfer request.",
|
| 400 |
+
"type": "string"
|
| 401 |
+
},
|
| 402 |
+
"newOwnerUserId": {
|
| 403 |
+
"description": "ID of the user to whom the data is being transferred.",
|
| 404 |
+
"type": "string"
|
| 405 |
+
},
|
| 406 |
+
"oldOwnerUserId": {
|
| 407 |
+
"description": "ID of the user whose data is being transferred.",
|
| 408 |
+
"type": "string"
|
| 409 |
+
},
|
| 410 |
+
"overallTransferStatusCode": {
|
| 411 |
+
"description": "Read-only. Overall transfer status.",
|
| 412 |
+
"type": "string"
|
| 413 |
+
},
|
| 414 |
+
"requestTime": {
|
| 415 |
+
"description": "Read-only. The time at which the data transfer was requested.",
|
| 416 |
+
"format": "date-time",
|
| 417 |
+
"type": "string"
|
| 418 |
+
}
|
| 419 |
+
},
|
| 420 |
+
"type": "object"
|
| 421 |
+
},
|
| 422 |
+
"DataTransfersListResponse": {
|
| 423 |
+
"description": "Template for a collection of DataTransfer resources.",
|
| 424 |
+
"id": "DataTransfersListResponse",
|
| 425 |
+
"properties": {
|
| 426 |
+
"dataTransfers": {
|
| 427 |
+
"description": "List of data transfer requests.",
|
| 428 |
+
"items": {
|
| 429 |
+
"$ref": "DataTransfer"
|
| 430 |
+
},
|
| 431 |
+
"type": "array"
|
| 432 |
+
},
|
| 433 |
+
"etag": {
|
| 434 |
+
"description": "ETag of the resource.",
|
| 435 |
+
"type": "string"
|
| 436 |
+
},
|
| 437 |
+
"kind": {
|
| 438 |
+
"default": "admin#datatransfer#dataTransfersList",
|
| 439 |
+
"description": "Identifies the resource as a collection of data transfer requests.",
|
| 440 |
+
"type": "string"
|
| 441 |
+
},
|
| 442 |
+
"nextPageToken": {
|
| 443 |
+
"description": "Token to specify the next page in the list.",
|
| 444 |
+
"type": "string"
|
| 445 |
+
}
|
| 446 |
+
},
|
| 447 |
+
"type": "object"
|
| 448 |
+
}
|
| 449 |
+
},
|
| 450 |
+
"servicePath": "",
|
| 451 |
+
"title": "Admin SDK API",
|
| 452 |
+
"version": "datatransfer_v1"
|
| 453 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/analyticshub.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/apikeys.v2.json
ADDED
|
@@ -0,0 +1,702 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only": {
|
| 9 |
+
"description": "View your data across Google Cloud services and see the email address of your Google Account"
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://apikeys.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "Api Keys Service",
|
| 18 |
+
"description": "Manages the API keys associated with developer projects.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://cloud.google.com/api-keys/docs",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "apikeys:v2",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://apikeys.mtls.googleapis.com/",
|
| 29 |
+
"name": "apikeys",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"parameters": {
|
| 33 |
+
"$.xgafv": {
|
| 34 |
+
"description": "V1 error format.",
|
| 35 |
+
"enum": [
|
| 36 |
+
"1",
|
| 37 |
+
"2"
|
| 38 |
+
],
|
| 39 |
+
"enumDescriptions": [
|
| 40 |
+
"v1 error format",
|
| 41 |
+
"v2 error format"
|
| 42 |
+
],
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"access_token": {
|
| 47 |
+
"description": "OAuth access token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"alt": {
|
| 52 |
+
"default": "json",
|
| 53 |
+
"description": "Data format for response.",
|
| 54 |
+
"enum": [
|
| 55 |
+
"json",
|
| 56 |
+
"media",
|
| 57 |
+
"proto"
|
| 58 |
+
],
|
| 59 |
+
"enumDescriptions": [
|
| 60 |
+
"Responses with Content-Type of application/json",
|
| 61 |
+
"Media download with context-dependent Content-Type",
|
| 62 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 63 |
+
],
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"callback": {
|
| 68 |
+
"description": "JSONP",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
},
|
| 72 |
+
"fields": {
|
| 73 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 74 |
+
"location": "query",
|
| 75 |
+
"type": "string"
|
| 76 |
+
},
|
| 77 |
+
"key": {
|
| 78 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 79 |
+
"location": "query",
|
| 80 |
+
"type": "string"
|
| 81 |
+
},
|
| 82 |
+
"oauth_token": {
|
| 83 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 84 |
+
"location": "query",
|
| 85 |
+
"type": "string"
|
| 86 |
+
},
|
| 87 |
+
"prettyPrint": {
|
| 88 |
+
"default": "true",
|
| 89 |
+
"description": "Returns response with indentations and line breaks.",
|
| 90 |
+
"location": "query",
|
| 91 |
+
"type": "boolean"
|
| 92 |
+
},
|
| 93 |
+
"quotaUser": {
|
| 94 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 95 |
+
"location": "query",
|
| 96 |
+
"type": "string"
|
| 97 |
+
},
|
| 98 |
+
"uploadType": {
|
| 99 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 100 |
+
"location": "query",
|
| 101 |
+
"type": "string"
|
| 102 |
+
},
|
| 103 |
+
"upload_protocol": {
|
| 104 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 105 |
+
"location": "query",
|
| 106 |
+
"type": "string"
|
| 107 |
+
}
|
| 108 |
+
},
|
| 109 |
+
"protocol": "rest",
|
| 110 |
+
"resources": {
|
| 111 |
+
"keys": {
|
| 112 |
+
"methods": {
|
| 113 |
+
"lookupKey": {
|
| 114 |
+
"description": "Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.",
|
| 115 |
+
"flatPath": "v2/keys:lookupKey",
|
| 116 |
+
"httpMethod": "GET",
|
| 117 |
+
"id": "apikeys.keys.lookupKey",
|
| 118 |
+
"parameterOrder": [],
|
| 119 |
+
"parameters": {
|
| 120 |
+
"keyString": {
|
| 121 |
+
"description": "Required. Finds the project that owns the key string value.",
|
| 122 |
+
"location": "query",
|
| 123 |
+
"type": "string"
|
| 124 |
+
}
|
| 125 |
+
},
|
| 126 |
+
"path": "v2/keys:lookupKey",
|
| 127 |
+
"response": {
|
| 128 |
+
"$ref": "V2LookupKeyResponse"
|
| 129 |
+
},
|
| 130 |
+
"scopes": [
|
| 131 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 132 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 133 |
+
]
|
| 134 |
+
}
|
| 135 |
+
}
|
| 136 |
+
},
|
| 137 |
+
"operations": {
|
| 138 |
+
"methods": {
|
| 139 |
+
"get": {
|
| 140 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 141 |
+
"flatPath": "v2/operations/{operationsId}",
|
| 142 |
+
"httpMethod": "GET",
|
| 143 |
+
"id": "apikeys.operations.get",
|
| 144 |
+
"parameterOrder": [
|
| 145 |
+
"name"
|
| 146 |
+
],
|
| 147 |
+
"parameters": {
|
| 148 |
+
"name": {
|
| 149 |
+
"description": "The name of the operation resource.",
|
| 150 |
+
"location": "path",
|
| 151 |
+
"pattern": "^operations/[^/]+$",
|
| 152 |
+
"required": true,
|
| 153 |
+
"type": "string"
|
| 154 |
+
}
|
| 155 |
+
},
|
| 156 |
+
"path": "v2/{+name}",
|
| 157 |
+
"response": {
|
| 158 |
+
"$ref": "Operation"
|
| 159 |
+
},
|
| 160 |
+
"scopes": [
|
| 161 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 162 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 163 |
+
]
|
| 164 |
+
}
|
| 165 |
+
}
|
| 166 |
+
},
|
| 167 |
+
"projects": {
|
| 168 |
+
"resources": {
|
| 169 |
+
"locations": {
|
| 170 |
+
"resources": {
|
| 171 |
+
"keys": {
|
| 172 |
+
"methods": {
|
| 173 |
+
"create": {
|
| 174 |
+
"description": "Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 175 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys",
|
| 176 |
+
"httpMethod": "POST",
|
| 177 |
+
"id": "apikeys.projects.locations.keys.create",
|
| 178 |
+
"parameterOrder": [
|
| 179 |
+
"parent"
|
| 180 |
+
],
|
| 181 |
+
"parameters": {
|
| 182 |
+
"keyId": {
|
| 183 |
+
"description": "User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.",
|
| 184 |
+
"location": "query",
|
| 185 |
+
"type": "string"
|
| 186 |
+
},
|
| 187 |
+
"parent": {
|
| 188 |
+
"description": "Required. The project in which the API key is created.",
|
| 189 |
+
"location": "path",
|
| 190 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 191 |
+
"required": true,
|
| 192 |
+
"type": "string"
|
| 193 |
+
}
|
| 194 |
+
},
|
| 195 |
+
"path": "v2/{+parent}/keys",
|
| 196 |
+
"request": {
|
| 197 |
+
"$ref": "V2Key"
|
| 198 |
+
},
|
| 199 |
+
"response": {
|
| 200 |
+
"$ref": "Operation"
|
| 201 |
+
},
|
| 202 |
+
"scopes": [
|
| 203 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 204 |
+
]
|
| 205 |
+
},
|
| 206 |
+
"delete": {
|
| 207 |
+
"description": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 208 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
|
| 209 |
+
"httpMethod": "DELETE",
|
| 210 |
+
"id": "apikeys.projects.locations.keys.delete",
|
| 211 |
+
"parameterOrder": [
|
| 212 |
+
"name"
|
| 213 |
+
],
|
| 214 |
+
"parameters": {
|
| 215 |
+
"etag": {
|
| 216 |
+
"description": "Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.",
|
| 217 |
+
"location": "query",
|
| 218 |
+
"type": "string"
|
| 219 |
+
},
|
| 220 |
+
"name": {
|
| 221 |
+
"description": "Required. The resource name of the API key to be deleted.",
|
| 222 |
+
"location": "path",
|
| 223 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
|
| 224 |
+
"required": true,
|
| 225 |
+
"type": "string"
|
| 226 |
+
}
|
| 227 |
+
},
|
| 228 |
+
"path": "v2/{+name}",
|
| 229 |
+
"response": {
|
| 230 |
+
"$ref": "Operation"
|
| 231 |
+
},
|
| 232 |
+
"scopes": [
|
| 233 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 234 |
+
]
|
| 235 |
+
},
|
| 236 |
+
"get": {
|
| 237 |
+
"description": "Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 238 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
|
| 239 |
+
"httpMethod": "GET",
|
| 240 |
+
"id": "apikeys.projects.locations.keys.get",
|
| 241 |
+
"parameterOrder": [
|
| 242 |
+
"name"
|
| 243 |
+
],
|
| 244 |
+
"parameters": {
|
| 245 |
+
"name": {
|
| 246 |
+
"description": "Required. The resource name of the API key to get.",
|
| 247 |
+
"location": "path",
|
| 248 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
|
| 249 |
+
"required": true,
|
| 250 |
+
"type": "string"
|
| 251 |
+
}
|
| 252 |
+
},
|
| 253 |
+
"path": "v2/{+name}",
|
| 254 |
+
"response": {
|
| 255 |
+
"$ref": "V2Key"
|
| 256 |
+
},
|
| 257 |
+
"scopes": [
|
| 258 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 259 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 260 |
+
]
|
| 261 |
+
},
|
| 262 |
+
"getKeyString": {
|
| 263 |
+
"description": "Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 264 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString",
|
| 265 |
+
"httpMethod": "GET",
|
| 266 |
+
"id": "apikeys.projects.locations.keys.getKeyString",
|
| 267 |
+
"parameterOrder": [
|
| 268 |
+
"name"
|
| 269 |
+
],
|
| 270 |
+
"parameters": {
|
| 271 |
+
"name": {
|
| 272 |
+
"description": "Required. The resource name of the API key to be retrieved.",
|
| 273 |
+
"location": "path",
|
| 274 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
|
| 275 |
+
"required": true,
|
| 276 |
+
"type": "string"
|
| 277 |
+
}
|
| 278 |
+
},
|
| 279 |
+
"path": "v2/{+name}/keyString",
|
| 280 |
+
"response": {
|
| 281 |
+
"$ref": "V2GetKeyStringResponse"
|
| 282 |
+
},
|
| 283 |
+
"scopes": [
|
| 284 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 285 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 286 |
+
]
|
| 287 |
+
},
|
| 288 |
+
"list": {
|
| 289 |
+
"description": "Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 290 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys",
|
| 291 |
+
"httpMethod": "GET",
|
| 292 |
+
"id": "apikeys.projects.locations.keys.list",
|
| 293 |
+
"parameterOrder": [
|
| 294 |
+
"parent"
|
| 295 |
+
],
|
| 296 |
+
"parameters": {
|
| 297 |
+
"pageSize": {
|
| 298 |
+
"description": "Optional. Specifies the maximum number of results to be returned at a time.",
|
| 299 |
+
"format": "int32",
|
| 300 |
+
"location": "query",
|
| 301 |
+
"type": "integer"
|
| 302 |
+
},
|
| 303 |
+
"pageToken": {
|
| 304 |
+
"description": "Optional. Requests a specific page of results.",
|
| 305 |
+
"location": "query",
|
| 306 |
+
"type": "string"
|
| 307 |
+
},
|
| 308 |
+
"parent": {
|
| 309 |
+
"description": "Required. Lists all API keys associated with this project.",
|
| 310 |
+
"location": "path",
|
| 311 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 312 |
+
"required": true,
|
| 313 |
+
"type": "string"
|
| 314 |
+
},
|
| 315 |
+
"showDeleted": {
|
| 316 |
+
"description": "Optional. Indicate that keys deleted in the past 30 days should also be returned.",
|
| 317 |
+
"location": "query",
|
| 318 |
+
"type": "boolean"
|
| 319 |
+
}
|
| 320 |
+
},
|
| 321 |
+
"path": "v2/{+parent}/keys",
|
| 322 |
+
"response": {
|
| 323 |
+
"$ref": "V2ListKeysResponse"
|
| 324 |
+
},
|
| 325 |
+
"scopes": [
|
| 326 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 327 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 328 |
+
]
|
| 329 |
+
},
|
| 330 |
+
"patch": {
|
| 331 |
+
"description": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 332 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
|
| 333 |
+
"httpMethod": "PATCH",
|
| 334 |
+
"id": "apikeys.projects.locations.keys.patch",
|
| 335 |
+
"parameterOrder": [
|
| 336 |
+
"name"
|
| 337 |
+
],
|
| 338 |
+
"parameters": {
|
| 339 |
+
"name": {
|
| 340 |
+
"description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 341 |
+
"location": "path",
|
| 342 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
|
| 343 |
+
"required": true,
|
| 344 |
+
"type": "string"
|
| 345 |
+
},
|
| 346 |
+
"updateMask": {
|
| 347 |
+
"description": "The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name`, `restrictions`, and `annotations`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value \"*\", the service treats it equivalent to replace all allowed mutable fields.",
|
| 348 |
+
"format": "google-fieldmask",
|
| 349 |
+
"location": "query",
|
| 350 |
+
"type": "string"
|
| 351 |
+
}
|
| 352 |
+
},
|
| 353 |
+
"path": "v2/{+name}",
|
| 354 |
+
"request": {
|
| 355 |
+
"$ref": "V2Key"
|
| 356 |
+
},
|
| 357 |
+
"response": {
|
| 358 |
+
"$ref": "Operation"
|
| 359 |
+
},
|
| 360 |
+
"scopes": [
|
| 361 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 362 |
+
]
|
| 363 |
+
},
|
| 364 |
+
"undelete": {
|
| 365 |
+
"description": "Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 366 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete",
|
| 367 |
+
"httpMethod": "POST",
|
| 368 |
+
"id": "apikeys.projects.locations.keys.undelete",
|
| 369 |
+
"parameterOrder": [
|
| 370 |
+
"name"
|
| 371 |
+
],
|
| 372 |
+
"parameters": {
|
| 373 |
+
"name": {
|
| 374 |
+
"description": "Required. The resource name of the API key to be undeleted.",
|
| 375 |
+
"location": "path",
|
| 376 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
|
| 377 |
+
"required": true,
|
| 378 |
+
"type": "string"
|
| 379 |
+
}
|
| 380 |
+
},
|
| 381 |
+
"path": "v2/{+name}:undelete",
|
| 382 |
+
"request": {
|
| 383 |
+
"$ref": "V2UndeleteKeyRequest"
|
| 384 |
+
},
|
| 385 |
+
"response": {
|
| 386 |
+
"$ref": "Operation"
|
| 387 |
+
},
|
| 388 |
+
"scopes": [
|
| 389 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 390 |
+
]
|
| 391 |
+
}
|
| 392 |
+
}
|
| 393 |
+
}
|
| 394 |
+
}
|
| 395 |
+
}
|
| 396 |
+
}
|
| 397 |
+
}
|
| 398 |
+
},
|
| 399 |
+
"revision": "20241016",
|
| 400 |
+
"rootUrl": "https://apikeys.googleapis.com/",
|
| 401 |
+
"schemas": {
|
| 402 |
+
"Operation": {
|
| 403 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 404 |
+
"id": "Operation",
|
| 405 |
+
"properties": {
|
| 406 |
+
"done": {
|
| 407 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 408 |
+
"type": "boolean"
|
| 409 |
+
},
|
| 410 |
+
"error": {
|
| 411 |
+
"$ref": "Status",
|
| 412 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 413 |
+
},
|
| 414 |
+
"metadata": {
|
| 415 |
+
"additionalProperties": {
|
| 416 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 417 |
+
"type": "any"
|
| 418 |
+
},
|
| 419 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 420 |
+
"type": "object"
|
| 421 |
+
},
|
| 422 |
+
"name": {
|
| 423 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 424 |
+
"type": "string"
|
| 425 |
+
},
|
| 426 |
+
"response": {
|
| 427 |
+
"additionalProperties": {
|
| 428 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 429 |
+
"type": "any"
|
| 430 |
+
},
|
| 431 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 432 |
+
"type": "object"
|
| 433 |
+
}
|
| 434 |
+
},
|
| 435 |
+
"type": "object"
|
| 436 |
+
},
|
| 437 |
+
"Status": {
|
| 438 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 439 |
+
"id": "Status",
|
| 440 |
+
"properties": {
|
| 441 |
+
"code": {
|
| 442 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 443 |
+
"format": "int32",
|
| 444 |
+
"type": "integer"
|
| 445 |
+
},
|
| 446 |
+
"details": {
|
| 447 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 448 |
+
"items": {
|
| 449 |
+
"additionalProperties": {
|
| 450 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 451 |
+
"type": "any"
|
| 452 |
+
},
|
| 453 |
+
"type": "object"
|
| 454 |
+
},
|
| 455 |
+
"type": "array"
|
| 456 |
+
},
|
| 457 |
+
"message": {
|
| 458 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 459 |
+
"type": "string"
|
| 460 |
+
}
|
| 461 |
+
},
|
| 462 |
+
"type": "object"
|
| 463 |
+
},
|
| 464 |
+
"V2AndroidApplication": {
|
| 465 |
+
"description": "Identifier of an Android application for key use.",
|
| 466 |
+
"id": "V2AndroidApplication",
|
| 467 |
+
"properties": {
|
| 468 |
+
"packageName": {
|
| 469 |
+
"description": "The package name of the application.",
|
| 470 |
+
"type": "string"
|
| 471 |
+
},
|
| 472 |
+
"sha1Fingerprint": {
|
| 473 |
+
"description": "The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.",
|
| 474 |
+
"type": "string"
|
| 475 |
+
}
|
| 476 |
+
},
|
| 477 |
+
"type": "object"
|
| 478 |
+
},
|
| 479 |
+
"V2AndroidKeyRestrictions": {
|
| 480 |
+
"description": "The Android apps that are allowed to use the key.",
|
| 481 |
+
"id": "V2AndroidKeyRestrictions",
|
| 482 |
+
"properties": {
|
| 483 |
+
"allowedApplications": {
|
| 484 |
+
"description": "A list of Android applications that are allowed to make API calls with this key.",
|
| 485 |
+
"items": {
|
| 486 |
+
"$ref": "V2AndroidApplication"
|
| 487 |
+
},
|
| 488 |
+
"type": "array"
|
| 489 |
+
}
|
| 490 |
+
},
|
| 491 |
+
"type": "object"
|
| 492 |
+
},
|
| 493 |
+
"V2ApiTarget": {
|
| 494 |
+
"description": "A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.",
|
| 495 |
+
"id": "V2ApiTarget",
|
| 496 |
+
"properties": {
|
| 497 |
+
"methods": {
|
| 498 |
+
"description": "Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`",
|
| 499 |
+
"items": {
|
| 500 |
+
"type": "string"
|
| 501 |
+
},
|
| 502 |
+
"type": "array"
|
| 503 |
+
},
|
| 504 |
+
"service": {
|
| 505 |
+
"description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.",
|
| 506 |
+
"type": "string"
|
| 507 |
+
}
|
| 508 |
+
},
|
| 509 |
+
"type": "object"
|
| 510 |
+
},
|
| 511 |
+
"V2BrowserKeyRestrictions": {
|
| 512 |
+
"description": "The HTTP referrers (websites) that are allowed to use the key.",
|
| 513 |
+
"id": "V2BrowserKeyRestrictions",
|
| 514 |
+
"properties": {
|
| 515 |
+
"allowedReferrers": {
|
| 516 |
+
"description": "A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.",
|
| 517 |
+
"items": {
|
| 518 |
+
"type": "string"
|
| 519 |
+
},
|
| 520 |
+
"type": "array"
|
| 521 |
+
}
|
| 522 |
+
},
|
| 523 |
+
"type": "object"
|
| 524 |
+
},
|
| 525 |
+
"V2GetKeyStringResponse": {
|
| 526 |
+
"description": "Response message for `GetKeyString` method.",
|
| 527 |
+
"id": "V2GetKeyStringResponse",
|
| 528 |
+
"properties": {
|
| 529 |
+
"keyString": {
|
| 530 |
+
"description": "An encrypted and signed value of the key.",
|
| 531 |
+
"type": "string"
|
| 532 |
+
}
|
| 533 |
+
},
|
| 534 |
+
"type": "object"
|
| 535 |
+
},
|
| 536 |
+
"V2IosKeyRestrictions": {
|
| 537 |
+
"description": "The iOS apps that are allowed to use the key.",
|
| 538 |
+
"id": "V2IosKeyRestrictions",
|
| 539 |
+
"properties": {
|
| 540 |
+
"allowedBundleIds": {
|
| 541 |
+
"description": "A list of bundle IDs that are allowed when making API calls with this key.",
|
| 542 |
+
"items": {
|
| 543 |
+
"type": "string"
|
| 544 |
+
},
|
| 545 |
+
"type": "array"
|
| 546 |
+
}
|
| 547 |
+
},
|
| 548 |
+
"type": "object"
|
| 549 |
+
},
|
| 550 |
+
"V2Key": {
|
| 551 |
+
"description": "The representation of a key managed by the API Keys API.",
|
| 552 |
+
"id": "V2Key",
|
| 553 |
+
"properties": {
|
| 554 |
+
"annotations": {
|
| 555 |
+
"additionalProperties": {
|
| 556 |
+
"type": "string"
|
| 557 |
+
},
|
| 558 |
+
"description": "Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
| 559 |
+
"type": "object"
|
| 560 |
+
},
|
| 561 |
+
"createTime": {
|
| 562 |
+
"description": "Output only. A timestamp identifying the time this key was originally created.",
|
| 563 |
+
"format": "google-datetime",
|
| 564 |
+
"readOnly": true,
|
| 565 |
+
"type": "string"
|
| 566 |
+
},
|
| 567 |
+
"deleteTime": {
|
| 568 |
+
"description": "Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.",
|
| 569 |
+
"format": "google-datetime",
|
| 570 |
+
"readOnly": true,
|
| 571 |
+
"type": "string"
|
| 572 |
+
},
|
| 573 |
+
"displayName": {
|
| 574 |
+
"description": "Human-readable display name of this key that you can modify. The maximum length is 63 characters.",
|
| 575 |
+
"type": "string"
|
| 576 |
+
},
|
| 577 |
+
"etag": {
|
| 578 |
+
"description": "Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.",
|
| 579 |
+
"readOnly": true,
|
| 580 |
+
"type": "string"
|
| 581 |
+
},
|
| 582 |
+
"keyString": {
|
| 583 |
+
"description": "Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.",
|
| 584 |
+
"readOnly": true,
|
| 585 |
+
"type": "string"
|
| 586 |
+
},
|
| 587 |
+
"name": {
|
| 588 |
+
"description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.",
|
| 589 |
+
"readOnly": true,
|
| 590 |
+
"type": "string"
|
| 591 |
+
},
|
| 592 |
+
"restrictions": {
|
| 593 |
+
"$ref": "V2Restrictions",
|
| 594 |
+
"description": "Key restrictions."
|
| 595 |
+
},
|
| 596 |
+
"serviceAccountEmail": {
|
| 597 |
+
"description": "Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to.",
|
| 598 |
+
"type": "string"
|
| 599 |
+
},
|
| 600 |
+
"uid": {
|
| 601 |
+
"description": "Output only. Unique id in UUID4 format.",
|
| 602 |
+
"readOnly": true,
|
| 603 |
+
"type": "string"
|
| 604 |
+
},
|
| 605 |
+
"updateTime": {
|
| 606 |
+
"description": "Output only. A timestamp identifying the time this key was last updated.",
|
| 607 |
+
"format": "google-datetime",
|
| 608 |
+
"readOnly": true,
|
| 609 |
+
"type": "string"
|
| 610 |
+
}
|
| 611 |
+
},
|
| 612 |
+
"type": "object"
|
| 613 |
+
},
|
| 614 |
+
"V2ListKeysResponse": {
|
| 615 |
+
"description": "Response message for `ListKeys` method.",
|
| 616 |
+
"id": "V2ListKeysResponse",
|
| 617 |
+
"properties": {
|
| 618 |
+
"keys": {
|
| 619 |
+
"description": "A list of API keys.",
|
| 620 |
+
"items": {
|
| 621 |
+
"$ref": "V2Key"
|
| 622 |
+
},
|
| 623 |
+
"type": "array"
|
| 624 |
+
},
|
| 625 |
+
"nextPageToken": {
|
| 626 |
+
"description": "The pagination token for the next page of results.",
|
| 627 |
+
"type": "string"
|
| 628 |
+
}
|
| 629 |
+
},
|
| 630 |
+
"type": "object"
|
| 631 |
+
},
|
| 632 |
+
"V2LookupKeyResponse": {
|
| 633 |
+
"description": "Response message for `LookupKey` method.",
|
| 634 |
+
"id": "V2LookupKeyResponse",
|
| 635 |
+
"properties": {
|
| 636 |
+
"name": {
|
| 637 |
+
"description": "The resource name of the API key. If the API key has been purged, resource name is empty.",
|
| 638 |
+
"type": "string"
|
| 639 |
+
},
|
| 640 |
+
"parent": {
|
| 641 |
+
"description": "The project that owns the key with the value specified in the request.",
|
| 642 |
+
"type": "string"
|
| 643 |
+
}
|
| 644 |
+
},
|
| 645 |
+
"type": "object"
|
| 646 |
+
},
|
| 647 |
+
"V2Restrictions": {
|
| 648 |
+
"description": "Describes the restrictions on the key.",
|
| 649 |
+
"id": "V2Restrictions",
|
| 650 |
+
"properties": {
|
| 651 |
+
"androidKeyRestrictions": {
|
| 652 |
+
"$ref": "V2AndroidKeyRestrictions",
|
| 653 |
+
"description": "The Android apps that are allowed to use the key."
|
| 654 |
+
},
|
| 655 |
+
"apiTargets": {
|
| 656 |
+
"description": "A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.",
|
| 657 |
+
"items": {
|
| 658 |
+
"$ref": "V2ApiTarget"
|
| 659 |
+
},
|
| 660 |
+
"type": "array"
|
| 661 |
+
},
|
| 662 |
+
"browserKeyRestrictions": {
|
| 663 |
+
"$ref": "V2BrowserKeyRestrictions",
|
| 664 |
+
"description": "The HTTP referrers (websites) that are allowed to use the key."
|
| 665 |
+
},
|
| 666 |
+
"iosKeyRestrictions": {
|
| 667 |
+
"$ref": "V2IosKeyRestrictions",
|
| 668 |
+
"description": "The iOS apps that are allowed to use the key."
|
| 669 |
+
},
|
| 670 |
+
"serverKeyRestrictions": {
|
| 671 |
+
"$ref": "V2ServerKeyRestrictions",
|
| 672 |
+
"description": "The IP addresses of callers that are allowed to use the key."
|
| 673 |
+
}
|
| 674 |
+
},
|
| 675 |
+
"type": "object"
|
| 676 |
+
},
|
| 677 |
+
"V2ServerKeyRestrictions": {
|
| 678 |
+
"description": "The IP addresses of callers that are allowed to use the key.",
|
| 679 |
+
"id": "V2ServerKeyRestrictions",
|
| 680 |
+
"properties": {
|
| 681 |
+
"allowedIps": {
|
| 682 |
+
"description": "A list of the caller IP addresses that are allowed to make API calls with this key.",
|
| 683 |
+
"items": {
|
| 684 |
+
"type": "string"
|
| 685 |
+
},
|
| 686 |
+
"type": "array"
|
| 687 |
+
}
|
| 688 |
+
},
|
| 689 |
+
"type": "object"
|
| 690 |
+
},
|
| 691 |
+
"V2UndeleteKeyRequest": {
|
| 692 |
+
"description": "Request message for `UndeleteKey` method.",
|
| 693 |
+
"id": "V2UndeleteKeyRequest",
|
| 694 |
+
"properties": {},
|
| 695 |
+
"type": "object"
|
| 696 |
+
}
|
| 697 |
+
},
|
| 698 |
+
"servicePath": "",
|
| 699 |
+
"title": "API Keys API",
|
| 700 |
+
"version": "v2",
|
| 701 |
+
"version_module": true
|
| 702 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json
ADDED
|
@@ -0,0 +1,2130 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://assuredworkloads.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Assuredworkloads",
|
| 15 |
+
"description": "",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/learnmoreurl",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "assuredworkloads:v1beta1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://assuredworkloads.mtls.googleapis.com/",
|
| 26 |
+
"name": "assuredworkloads",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"organizations": {
|
| 109 |
+
"resources": {
|
| 110 |
+
"locations": {
|
| 111 |
+
"resources": {
|
| 112 |
+
"operations": {
|
| 113 |
+
"methods": {
|
| 114 |
+
"get": {
|
| 115 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 116 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}",
|
| 117 |
+
"httpMethod": "GET",
|
| 118 |
+
"id": "assuredworkloads.organizations.locations.operations.get",
|
| 119 |
+
"parameterOrder": [
|
| 120 |
+
"name"
|
| 121 |
+
],
|
| 122 |
+
"parameters": {
|
| 123 |
+
"name": {
|
| 124 |
+
"description": "The name of the operation resource.",
|
| 125 |
+
"location": "path",
|
| 126 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 127 |
+
"required": true,
|
| 128 |
+
"type": "string"
|
| 129 |
+
}
|
| 130 |
+
},
|
| 131 |
+
"path": "v1beta1/{+name}",
|
| 132 |
+
"response": {
|
| 133 |
+
"$ref": "GoogleLongrunningOperation"
|
| 134 |
+
},
|
| 135 |
+
"scopes": [
|
| 136 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 137 |
+
]
|
| 138 |
+
},
|
| 139 |
+
"list": {
|
| 140 |
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
| 141 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations",
|
| 142 |
+
"httpMethod": "GET",
|
| 143 |
+
"id": "assuredworkloads.organizations.locations.operations.list",
|
| 144 |
+
"parameterOrder": [
|
| 145 |
+
"name"
|
| 146 |
+
],
|
| 147 |
+
"parameters": {
|
| 148 |
+
"filter": {
|
| 149 |
+
"description": "The standard list filter.",
|
| 150 |
+
"location": "query",
|
| 151 |
+
"type": "string"
|
| 152 |
+
},
|
| 153 |
+
"name": {
|
| 154 |
+
"description": "The name of the operation's parent resource.",
|
| 155 |
+
"location": "path",
|
| 156 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+$",
|
| 157 |
+
"required": true,
|
| 158 |
+
"type": "string"
|
| 159 |
+
},
|
| 160 |
+
"pageSize": {
|
| 161 |
+
"description": "The standard list page size.",
|
| 162 |
+
"format": "int32",
|
| 163 |
+
"location": "query",
|
| 164 |
+
"type": "integer"
|
| 165 |
+
},
|
| 166 |
+
"pageToken": {
|
| 167 |
+
"description": "The standard list page token.",
|
| 168 |
+
"location": "query",
|
| 169 |
+
"type": "string"
|
| 170 |
+
}
|
| 171 |
+
},
|
| 172 |
+
"path": "v1beta1/{+name}/operations",
|
| 173 |
+
"response": {
|
| 174 |
+
"$ref": "GoogleLongrunningListOperationsResponse"
|
| 175 |
+
},
|
| 176 |
+
"scopes": [
|
| 177 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 178 |
+
]
|
| 179 |
+
}
|
| 180 |
+
}
|
| 181 |
+
},
|
| 182 |
+
"workloads": {
|
| 183 |
+
"methods": {
|
| 184 |
+
"analyzeWorkloadMove": {
|
| 185 |
+
"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.",
|
| 186 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove",
|
| 187 |
+
"httpMethod": "GET",
|
| 188 |
+
"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove",
|
| 189 |
+
"parameterOrder": [
|
| 190 |
+
"target"
|
| 191 |
+
],
|
| 192 |
+
"parameters": {
|
| 193 |
+
"assetTypes": {
|
| 194 |
+
"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).",
|
| 195 |
+
"location": "query",
|
| 196 |
+
"repeated": true,
|
| 197 |
+
"type": "string"
|
| 198 |
+
},
|
| 199 |
+
"pageSize": {
|
| 200 |
+
"description": "Optional. Page size. If a value is not specified, the default value of 10 is used.",
|
| 201 |
+
"format": "int32",
|
| 202 |
+
"location": "query",
|
| 203 |
+
"type": "integer"
|
| 204 |
+
},
|
| 205 |
+
"pageToken": {
|
| 206 |
+
"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.",
|
| 207 |
+
"location": "query",
|
| 208 |
+
"type": "string"
|
| 209 |
+
},
|
| 210 |
+
"project": {
|
| 211 |
+
"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.",
|
| 212 |
+
"location": "query",
|
| 213 |
+
"type": "string"
|
| 214 |
+
},
|
| 215 |
+
"target": {
|
| 216 |
+
"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"",
|
| 217 |
+
"location": "path",
|
| 218 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 219 |
+
"required": true,
|
| 220 |
+
"type": "string"
|
| 221 |
+
}
|
| 222 |
+
},
|
| 223 |
+
"path": "v1beta1/{+target}:analyzeWorkloadMove",
|
| 224 |
+
"response": {
|
| 225 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse"
|
| 226 |
+
},
|
| 227 |
+
"scopes": [
|
| 228 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 229 |
+
]
|
| 230 |
+
},
|
| 231 |
+
"create": {
|
| 232 |
+
"description": "Creates Assured Workload.",
|
| 233 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads",
|
| 234 |
+
"httpMethod": "POST",
|
| 235 |
+
"id": "assuredworkloads.organizations.locations.workloads.create",
|
| 236 |
+
"parameterOrder": [
|
| 237 |
+
"parent"
|
| 238 |
+
],
|
| 239 |
+
"parameters": {
|
| 240 |
+
"externalId": {
|
| 241 |
+
"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.",
|
| 242 |
+
"location": "query",
|
| 243 |
+
"type": "string"
|
| 244 |
+
},
|
| 245 |
+
"parent": {
|
| 246 |
+
"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.",
|
| 247 |
+
"location": "path",
|
| 248 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+$",
|
| 249 |
+
"required": true,
|
| 250 |
+
"type": "string"
|
| 251 |
+
}
|
| 252 |
+
},
|
| 253 |
+
"path": "v1beta1/{+parent}/workloads",
|
| 254 |
+
"request": {
|
| 255 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
|
| 256 |
+
},
|
| 257 |
+
"response": {
|
| 258 |
+
"$ref": "GoogleLongrunningOperation"
|
| 259 |
+
},
|
| 260 |
+
"scopes": [
|
| 261 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 262 |
+
]
|
| 263 |
+
},
|
| 264 |
+
"delete": {
|
| 265 |
+
"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.",
|
| 266 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
|
| 267 |
+
"httpMethod": "DELETE",
|
| 268 |
+
"id": "assuredworkloads.organizations.locations.workloads.delete",
|
| 269 |
+
"parameterOrder": [
|
| 270 |
+
"name"
|
| 271 |
+
],
|
| 272 |
+
"parameters": {
|
| 273 |
+
"etag": {
|
| 274 |
+
"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.",
|
| 275 |
+
"location": "query",
|
| 276 |
+
"type": "string"
|
| 277 |
+
},
|
| 278 |
+
"name": {
|
| 279 |
+
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
|
| 280 |
+
"location": "path",
|
| 281 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 282 |
+
"required": true,
|
| 283 |
+
"type": "string"
|
| 284 |
+
}
|
| 285 |
+
},
|
| 286 |
+
"path": "v1beta1/{+name}",
|
| 287 |
+
"response": {
|
| 288 |
+
"$ref": "GoogleProtobufEmpty"
|
| 289 |
+
},
|
| 290 |
+
"scopes": [
|
| 291 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 292 |
+
]
|
| 293 |
+
},
|
| 294 |
+
"enableComplianceUpdates": {
|
| 295 |
+
"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.",
|
| 296 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates",
|
| 297 |
+
"httpMethod": "PUT",
|
| 298 |
+
"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates",
|
| 299 |
+
"parameterOrder": [
|
| 300 |
+
"name"
|
| 301 |
+
],
|
| 302 |
+
"parameters": {
|
| 303 |
+
"name": {
|
| 304 |
+
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
|
| 305 |
+
"location": "path",
|
| 306 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 307 |
+
"required": true,
|
| 308 |
+
"type": "string"
|
| 309 |
+
}
|
| 310 |
+
},
|
| 311 |
+
"path": "v1beta1/{+name}:enableComplianceUpdates",
|
| 312 |
+
"response": {
|
| 313 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse"
|
| 314 |
+
},
|
| 315 |
+
"scopes": [
|
| 316 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 317 |
+
]
|
| 318 |
+
},
|
| 319 |
+
"enableResourceMonitoring": {
|
| 320 |
+
"description": "Enable resource violation monitoring for a workload.",
|
| 321 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring",
|
| 322 |
+
"httpMethod": "POST",
|
| 323 |
+
"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring",
|
| 324 |
+
"parameterOrder": [
|
| 325 |
+
"name"
|
| 326 |
+
],
|
| 327 |
+
"parameters": {
|
| 328 |
+
"name": {
|
| 329 |
+
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
|
| 330 |
+
"location": "path",
|
| 331 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 332 |
+
"required": true,
|
| 333 |
+
"type": "string"
|
| 334 |
+
}
|
| 335 |
+
},
|
| 336 |
+
"path": "v1beta1/{+name}:enableResourceMonitoring",
|
| 337 |
+
"response": {
|
| 338 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse"
|
| 339 |
+
},
|
| 340 |
+
"scopes": [
|
| 341 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 342 |
+
]
|
| 343 |
+
},
|
| 344 |
+
"get": {
|
| 345 |
+
"description": "Gets Assured Workload associated with a CRM Node",
|
| 346 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
|
| 347 |
+
"httpMethod": "GET",
|
| 348 |
+
"id": "assuredworkloads.organizations.locations.workloads.get",
|
| 349 |
+
"parameterOrder": [
|
| 350 |
+
"name"
|
| 351 |
+
],
|
| 352 |
+
"parameters": {
|
| 353 |
+
"name": {
|
| 354 |
+
"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
|
| 355 |
+
"location": "path",
|
| 356 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 357 |
+
"required": true,
|
| 358 |
+
"type": "string"
|
| 359 |
+
}
|
| 360 |
+
},
|
| 361 |
+
"path": "v1beta1/{+name}",
|
| 362 |
+
"response": {
|
| 363 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
|
| 364 |
+
},
|
| 365 |
+
"scopes": [
|
| 366 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 367 |
+
]
|
| 368 |
+
},
|
| 369 |
+
"list": {
|
| 370 |
+
"description": "Lists Assured Workloads under a CRM Node.",
|
| 371 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads",
|
| 372 |
+
"httpMethod": "GET",
|
| 373 |
+
"id": "assuredworkloads.organizations.locations.workloads.list",
|
| 374 |
+
"parameterOrder": [
|
| 375 |
+
"parent"
|
| 376 |
+
],
|
| 377 |
+
"parameters": {
|
| 378 |
+
"filter": {
|
| 379 |
+
"description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.",
|
| 380 |
+
"location": "query",
|
| 381 |
+
"type": "string"
|
| 382 |
+
},
|
| 383 |
+
"pageSize": {
|
| 384 |
+
"description": "Page size.",
|
| 385 |
+
"format": "int32",
|
| 386 |
+
"location": "query",
|
| 387 |
+
"type": "integer"
|
| 388 |
+
},
|
| 389 |
+
"pageToken": {
|
| 390 |
+
"description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.",
|
| 391 |
+
"location": "query",
|
| 392 |
+
"type": "string"
|
| 393 |
+
},
|
| 394 |
+
"parent": {
|
| 395 |
+
"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.",
|
| 396 |
+
"location": "path",
|
| 397 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+$",
|
| 398 |
+
"required": true,
|
| 399 |
+
"type": "string"
|
| 400 |
+
}
|
| 401 |
+
},
|
| 402 |
+
"path": "v1beta1/{+parent}/workloads",
|
| 403 |
+
"response": {
|
| 404 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse"
|
| 405 |
+
},
|
| 406 |
+
"scopes": [
|
| 407 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 408 |
+
]
|
| 409 |
+
},
|
| 410 |
+
"patch": {
|
| 411 |
+
"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.",
|
| 412 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
|
| 413 |
+
"httpMethod": "PATCH",
|
| 414 |
+
"id": "assuredworkloads.organizations.locations.workloads.patch",
|
| 415 |
+
"parameterOrder": [
|
| 416 |
+
"name"
|
| 417 |
+
],
|
| 418 |
+
"parameters": {
|
| 419 |
+
"name": {
|
| 420 |
+
"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.",
|
| 421 |
+
"location": "path",
|
| 422 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 423 |
+
"required": true,
|
| 424 |
+
"type": "string"
|
| 425 |
+
},
|
| 426 |
+
"updateMask": {
|
| 427 |
+
"description": "Required. The list of fields to be updated.",
|
| 428 |
+
"format": "google-fieldmask",
|
| 429 |
+
"location": "query",
|
| 430 |
+
"type": "string"
|
| 431 |
+
}
|
| 432 |
+
},
|
| 433 |
+
"path": "v1beta1/{+name}",
|
| 434 |
+
"request": {
|
| 435 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
|
| 436 |
+
},
|
| 437 |
+
"response": {
|
| 438 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
|
| 439 |
+
},
|
| 440 |
+
"scopes": [
|
| 441 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 442 |
+
]
|
| 443 |
+
},
|
| 444 |
+
"restrictAllowedResources": {
|
| 445 |
+
"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.",
|
| 446 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources",
|
| 447 |
+
"httpMethod": "POST",
|
| 448 |
+
"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources",
|
| 449 |
+
"parameterOrder": [
|
| 450 |
+
"name"
|
| 451 |
+
],
|
| 452 |
+
"parameters": {
|
| 453 |
+
"name": {
|
| 454 |
+
"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
|
| 455 |
+
"location": "path",
|
| 456 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 457 |
+
"required": true,
|
| 458 |
+
"type": "string"
|
| 459 |
+
}
|
| 460 |
+
},
|
| 461 |
+
"path": "v1beta1/{+name}:restrictAllowedResources",
|
| 462 |
+
"request": {
|
| 463 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest"
|
| 464 |
+
},
|
| 465 |
+
"response": {
|
| 466 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse"
|
| 467 |
+
},
|
| 468 |
+
"scopes": [
|
| 469 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 470 |
+
]
|
| 471 |
+
}
|
| 472 |
+
},
|
| 473 |
+
"resources": {
|
| 474 |
+
"updates": {
|
| 475 |
+
"methods": {
|
| 476 |
+
"apply": {
|
| 477 |
+
"description": "This endpoint creates a new operation to apply the given update.",
|
| 478 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply",
|
| 479 |
+
"httpMethod": "POST",
|
| 480 |
+
"id": "assuredworkloads.organizations.locations.workloads.updates.apply",
|
| 481 |
+
"parameterOrder": [
|
| 482 |
+
"name"
|
| 483 |
+
],
|
| 484 |
+
"parameters": {
|
| 485 |
+
"name": {
|
| 486 |
+
"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}",
|
| 487 |
+
"location": "path",
|
| 488 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$",
|
| 489 |
+
"required": true,
|
| 490 |
+
"type": "string"
|
| 491 |
+
}
|
| 492 |
+
},
|
| 493 |
+
"path": "v1beta1/{+name}:apply",
|
| 494 |
+
"request": {
|
| 495 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest"
|
| 496 |
+
},
|
| 497 |
+
"response": {
|
| 498 |
+
"$ref": "GoogleLongrunningOperation"
|
| 499 |
+
},
|
| 500 |
+
"scopes": [
|
| 501 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 502 |
+
]
|
| 503 |
+
},
|
| 504 |
+
"list": {
|
| 505 |
+
"description": "This endpoint lists all updates for the given workload.",
|
| 506 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates",
|
| 507 |
+
"httpMethod": "GET",
|
| 508 |
+
"id": "assuredworkloads.organizations.locations.workloads.updates.list",
|
| 509 |
+
"parameterOrder": [
|
| 510 |
+
"parent"
|
| 511 |
+
],
|
| 512 |
+
"parameters": {
|
| 513 |
+
"pageSize": {
|
| 514 |
+
"description": "Page size. The default value is 20 and the max allowed value is 100.",
|
| 515 |
+
"format": "int32",
|
| 516 |
+
"location": "query",
|
| 517 |
+
"type": "integer"
|
| 518 |
+
},
|
| 519 |
+
"pageToken": {
|
| 520 |
+
"description": "Page token returned from previous request.",
|
| 521 |
+
"location": "query",
|
| 522 |
+
"type": "string"
|
| 523 |
+
},
|
| 524 |
+
"parent": {
|
| 525 |
+
"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
|
| 526 |
+
"location": "path",
|
| 527 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 528 |
+
"required": true,
|
| 529 |
+
"type": "string"
|
| 530 |
+
}
|
| 531 |
+
},
|
| 532 |
+
"path": "v1beta1/{+parent}/updates",
|
| 533 |
+
"response": {
|
| 534 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse"
|
| 535 |
+
},
|
| 536 |
+
"scopes": [
|
| 537 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 538 |
+
]
|
| 539 |
+
}
|
| 540 |
+
}
|
| 541 |
+
},
|
| 542 |
+
"violations": {
|
| 543 |
+
"methods": {
|
| 544 |
+
"acknowledge": {
|
| 545 |
+
"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.",
|
| 546 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge",
|
| 547 |
+
"httpMethod": "POST",
|
| 548 |
+
"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge",
|
| 549 |
+
"parameterOrder": [
|
| 550 |
+
"name"
|
| 551 |
+
],
|
| 552 |
+
"parameters": {
|
| 553 |
+
"name": {
|
| 554 |
+
"description": "Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}",
|
| 555 |
+
"location": "path",
|
| 556 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$",
|
| 557 |
+
"required": true,
|
| 558 |
+
"type": "string"
|
| 559 |
+
}
|
| 560 |
+
},
|
| 561 |
+
"path": "v1beta1/{+name}:acknowledge",
|
| 562 |
+
"request": {
|
| 563 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest"
|
| 564 |
+
},
|
| 565 |
+
"response": {
|
| 566 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse"
|
| 567 |
+
},
|
| 568 |
+
"scopes": [
|
| 569 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 570 |
+
]
|
| 571 |
+
},
|
| 572 |
+
"get": {
|
| 573 |
+
"description": "Retrieves Assured Workload Violation based on ID.",
|
| 574 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}",
|
| 575 |
+
"httpMethod": "GET",
|
| 576 |
+
"id": "assuredworkloads.organizations.locations.workloads.violations.get",
|
| 577 |
+
"parameterOrder": [
|
| 578 |
+
"name"
|
| 579 |
+
],
|
| 580 |
+
"parameters": {
|
| 581 |
+
"name": {
|
| 582 |
+
"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}",
|
| 583 |
+
"location": "path",
|
| 584 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$",
|
| 585 |
+
"required": true,
|
| 586 |
+
"type": "string"
|
| 587 |
+
}
|
| 588 |
+
},
|
| 589 |
+
"path": "v1beta1/{+name}",
|
| 590 |
+
"response": {
|
| 591 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation"
|
| 592 |
+
},
|
| 593 |
+
"scopes": [
|
| 594 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 595 |
+
]
|
| 596 |
+
},
|
| 597 |
+
"list": {
|
| 598 |
+
"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`",
|
| 599 |
+
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations",
|
| 600 |
+
"httpMethod": "GET",
|
| 601 |
+
"id": "assuredworkloads.organizations.locations.workloads.violations.list",
|
| 602 |
+
"parameterOrder": [
|
| 603 |
+
"parent"
|
| 604 |
+
],
|
| 605 |
+
"parameters": {
|
| 606 |
+
"filter": {
|
| 607 |
+
"description": "Optional. A custom filter for filtering by the Violations properties.",
|
| 608 |
+
"location": "query",
|
| 609 |
+
"type": "string"
|
| 610 |
+
},
|
| 611 |
+
"interval.endTime": {
|
| 612 |
+
"description": "The end of the time window.",
|
| 613 |
+
"format": "google-datetime",
|
| 614 |
+
"location": "query",
|
| 615 |
+
"type": "string"
|
| 616 |
+
},
|
| 617 |
+
"interval.startTime": {
|
| 618 |
+
"description": "The start of the time window.",
|
| 619 |
+
"format": "google-datetime",
|
| 620 |
+
"location": "query",
|
| 621 |
+
"type": "string"
|
| 622 |
+
},
|
| 623 |
+
"pageSize": {
|
| 624 |
+
"description": "Optional. Page size.",
|
| 625 |
+
"format": "int32",
|
| 626 |
+
"location": "query",
|
| 627 |
+
"type": "integer"
|
| 628 |
+
},
|
| 629 |
+
"pageToken": {
|
| 630 |
+
"description": "Optional. Page token returned from previous request.",
|
| 631 |
+
"location": "query",
|
| 632 |
+
"type": "string"
|
| 633 |
+
},
|
| 634 |
+
"parent": {
|
| 635 |
+
"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.",
|
| 636 |
+
"location": "path",
|
| 637 |
+
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
|
| 638 |
+
"required": true,
|
| 639 |
+
"type": "string"
|
| 640 |
+
}
|
| 641 |
+
},
|
| 642 |
+
"path": "v1beta1/{+parent}/violations",
|
| 643 |
+
"response": {
|
| 644 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse"
|
| 645 |
+
},
|
| 646 |
+
"scopes": [
|
| 647 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 648 |
+
]
|
| 649 |
+
}
|
| 650 |
+
}
|
| 651 |
+
}
|
| 652 |
+
}
|
| 653 |
+
}
|
| 654 |
+
}
|
| 655 |
+
}
|
| 656 |
+
}
|
| 657 |
+
}
|
| 658 |
+
},
|
| 659 |
+
"revision": "20241206",
|
| 660 |
+
"rootUrl": "https://assuredworkloads.googleapis.com/",
|
| 661 |
+
"schemas": {
|
| 662 |
+
"GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": {
|
| 663 |
+
"description": "Request for acknowledging the violation",
|
| 664 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest",
|
| 665 |
+
"properties": {
|
| 666 |
+
"acknowledgeType": {
|
| 667 |
+
"description": "Optional. Acknowledge type of specified violation.",
|
| 668 |
+
"enum": [
|
| 669 |
+
"ACKNOWLEDGE_TYPE_UNSPECIFIED",
|
| 670 |
+
"SINGLE_VIOLATION",
|
| 671 |
+
"EXISTING_CHILD_RESOURCE_VIOLATIONS"
|
| 672 |
+
],
|
| 673 |
+
"enumDescriptions": [
|
| 674 |
+
"Acknowledge type unspecified.",
|
| 675 |
+
"Acknowledge only the specific violation.",
|
| 676 |
+
"Acknowledge specified orgPolicy violation and also associated resource violations."
|
| 677 |
+
],
|
| 678 |
+
"type": "string"
|
| 679 |
+
},
|
| 680 |
+
"comment": {
|
| 681 |
+
"description": "Required. Business justification explaining the need for violation acknowledgement",
|
| 682 |
+
"type": "string"
|
| 683 |
+
},
|
| 684 |
+
"nonCompliantOrgPolicy": {
|
| 685 |
+
"deprecated": true,
|
| 686 |
+
"description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}",
|
| 687 |
+
"type": "string"
|
| 688 |
+
}
|
| 689 |
+
},
|
| 690 |
+
"type": "object"
|
| 691 |
+
},
|
| 692 |
+
"GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse": {
|
| 693 |
+
"description": "Response for violation acknowledgement",
|
| 694 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse",
|
| 695 |
+
"properties": {},
|
| 696 |
+
"type": "object"
|
| 697 |
+
},
|
| 698 |
+
"GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse": {
|
| 699 |
+
"description": "Response containing the analysis results for the hypothetical resource move.",
|
| 700 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse",
|
| 701 |
+
"properties": {
|
| 702 |
+
"assetMoveAnalyses": {
|
| 703 |
+
"description": "List of analysis results for each asset in scope.",
|
| 704 |
+
"items": {
|
| 705 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis"
|
| 706 |
+
},
|
| 707 |
+
"type": "array"
|
| 708 |
+
},
|
| 709 |
+
"nextPageToken": {
|
| 710 |
+
"description": "The next page token. Is empty if the last page is reached.",
|
| 711 |
+
"type": "string"
|
| 712 |
+
}
|
| 713 |
+
},
|
| 714 |
+
"type": "object"
|
| 715 |
+
},
|
| 716 |
+
"GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateOperationMetadata": {
|
| 717 |
+
"description": "Operation metadata to give request details of ApplyWorkloadUpdate.",
|
| 718 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateOperationMetadata",
|
| 719 |
+
"properties": {
|
| 720 |
+
"action": {
|
| 721 |
+
"description": "Optional. The time the operation was created.",
|
| 722 |
+
"enum": [
|
| 723 |
+
"WORKLOAD_UPDATE_ACTION_UNSPECIFIED",
|
| 724 |
+
"APPLY"
|
| 725 |
+
],
|
| 726 |
+
"enumDescriptions": [
|
| 727 |
+
"Unspecified value.",
|
| 728 |
+
"The update is applied."
|
| 729 |
+
],
|
| 730 |
+
"type": "string"
|
| 731 |
+
},
|
| 732 |
+
"createTime": {
|
| 733 |
+
"description": "Optional. Output only. The time the operation was created.",
|
| 734 |
+
"format": "google-datetime",
|
| 735 |
+
"readOnly": true,
|
| 736 |
+
"type": "string"
|
| 737 |
+
},
|
| 738 |
+
"updateName": {
|
| 739 |
+
"description": "Required. The resource name of the update",
|
| 740 |
+
"type": "string"
|
| 741 |
+
}
|
| 742 |
+
},
|
| 743 |
+
"type": "object"
|
| 744 |
+
},
|
| 745 |
+
"GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest": {
|
| 746 |
+
"description": "Request to apply update to a workload.",
|
| 747 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest",
|
| 748 |
+
"properties": {
|
| 749 |
+
"action": {
|
| 750 |
+
"description": "The action to be performed on the update.",
|
| 751 |
+
"enum": [
|
| 752 |
+
"WORKLOAD_UPDATE_ACTION_UNSPECIFIED",
|
| 753 |
+
"APPLY"
|
| 754 |
+
],
|
| 755 |
+
"enumDescriptions": [
|
| 756 |
+
"Unspecified value.",
|
| 757 |
+
"The update is applied."
|
| 758 |
+
],
|
| 759 |
+
"type": "string"
|
| 760 |
+
}
|
| 761 |
+
},
|
| 762 |
+
"type": "object"
|
| 763 |
+
},
|
| 764 |
+
"GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse": {
|
| 765 |
+
"description": "Response for ApplyWorkloadUpdate endpoint.",
|
| 766 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse",
|
| 767 |
+
"properties": {
|
| 768 |
+
"appliedUpdate": {
|
| 769 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate",
|
| 770 |
+
"description": "The update that was applied."
|
| 771 |
+
}
|
| 772 |
+
},
|
| 773 |
+
"type": "object"
|
| 774 |
+
},
|
| 775 |
+
"GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": {
|
| 776 |
+
"description": "Represents move analysis results for an asset.",
|
| 777 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis",
|
| 778 |
+
"properties": {
|
| 779 |
+
"analysisGroups": {
|
| 780 |
+
"description": "List of eligible analyses performed for the asset.",
|
| 781 |
+
"items": {
|
| 782 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup"
|
| 783 |
+
},
|
| 784 |
+
"type": "array"
|
| 785 |
+
},
|
| 786 |
+
"asset": {
|
| 787 |
+
"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1",
|
| 788 |
+
"type": "string"
|
| 789 |
+
},
|
| 790 |
+
"assetType": {
|
| 791 |
+
"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).",
|
| 792 |
+
"type": "string"
|
| 793 |
+
}
|
| 794 |
+
},
|
| 795 |
+
"type": "object"
|
| 796 |
+
},
|
| 797 |
+
"GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata": {
|
| 798 |
+
"description": "Operation metadata to give request details of CreateWorkload.",
|
| 799 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata",
|
| 800 |
+
"properties": {
|
| 801 |
+
"complianceRegime": {
|
| 802 |
+
"description": "Optional. Compliance controls that should be applied to the resources managed by the workload.",
|
| 803 |
+
"enum": [
|
| 804 |
+
"COMPLIANCE_REGIME_UNSPECIFIED",
|
| 805 |
+
"IL4",
|
| 806 |
+
"CJIS",
|
| 807 |
+
"FEDRAMP_HIGH",
|
| 808 |
+
"FEDRAMP_MODERATE",
|
| 809 |
+
"US_REGIONAL_ACCESS",
|
| 810 |
+
"HIPAA",
|
| 811 |
+
"HITRUST",
|
| 812 |
+
"EU_REGIONS_AND_SUPPORT",
|
| 813 |
+
"CA_REGIONS_AND_SUPPORT",
|
| 814 |
+
"ITAR",
|
| 815 |
+
"AU_REGIONS_AND_US_SUPPORT",
|
| 816 |
+
"ASSURED_WORKLOADS_FOR_PARTNERS",
|
| 817 |
+
"ISR_REGIONS",
|
| 818 |
+
"ISR_REGIONS_AND_SUPPORT",
|
| 819 |
+
"CA_PROTECTED_B",
|
| 820 |
+
"IL5",
|
| 821 |
+
"IL2",
|
| 822 |
+
"JP_REGIONS_AND_SUPPORT",
|
| 823 |
+
"KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS",
|
| 824 |
+
"REGIONAL_CONTROLS",
|
| 825 |
+
"HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS",
|
| 826 |
+
"HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT",
|
| 827 |
+
"IRS_1075",
|
| 828 |
+
"CANADA_CONTROLLED_GOODS"
|
| 829 |
+
],
|
| 830 |
+
"enumDeprecated": [
|
| 831 |
+
false,
|
| 832 |
+
false,
|
| 833 |
+
false,
|
| 834 |
+
false,
|
| 835 |
+
false,
|
| 836 |
+
false,
|
| 837 |
+
true,
|
| 838 |
+
true,
|
| 839 |
+
false,
|
| 840 |
+
false,
|
| 841 |
+
false,
|
| 842 |
+
false,
|
| 843 |
+
false,
|
| 844 |
+
false,
|
| 845 |
+
false,
|
| 846 |
+
false,
|
| 847 |
+
false,
|
| 848 |
+
false,
|
| 849 |
+
false,
|
| 850 |
+
false,
|
| 851 |
+
false,
|
| 852 |
+
false,
|
| 853 |
+
false,
|
| 854 |
+
false,
|
| 855 |
+
false
|
| 856 |
+
],
|
| 857 |
+
"enumDescriptions": [
|
| 858 |
+
"Unknown compliance regime.",
|
| 859 |
+
"Information protection as per DoD IL4 requirements.",
|
| 860 |
+
"Criminal Justice Information Services (CJIS) Security policies.",
|
| 861 |
+
"FedRAMP High data protection controls",
|
| 862 |
+
"FedRAMP Moderate data protection controls",
|
| 863 |
+
"Assured Workloads For US Regions data protection controls",
|
| 864 |
+
"[DEPRECATED] Health Insurance Portability and Accountability Act controls",
|
| 865 |
+
"[DEPRECATED] Health Information Trust Alliance controls",
|
| 866 |
+
"Assured Workloads For EU Regions and Support controls",
|
| 867 |
+
"Assured Workloads For Canada Regions and Support controls",
|
| 868 |
+
"International Traffic in Arms Regulations",
|
| 869 |
+
"Assured Workloads for Australia Regions and Support controls",
|
| 870 |
+
"Assured Workloads for Partners;",
|
| 871 |
+
"Assured Workloads for Israel Regions",
|
| 872 |
+
"Assured Workloads for Israel Regions",
|
| 873 |
+
"Assured Workloads for Canada Protected B regime",
|
| 874 |
+
"Information protection as per DoD IL5 requirements.",
|
| 875 |
+
"Information protection as per DoD IL2 requirements.",
|
| 876 |
+
"Assured Workloads for Japan Regions",
|
| 877 |
+
"Assured Workloads Sovereign Controls KSA",
|
| 878 |
+
"Assured Workloads for Regional Controls",
|
| 879 |
+
"Healthcare and Life Science Controls",
|
| 880 |
+
"Healthcare and Life Science Controls with US Support",
|
| 881 |
+
"Internal Revenue Service 1075 controls",
|
| 882 |
+
"Canada Controlled Goods"
|
| 883 |
+
],
|
| 884 |
+
"type": "string"
|
| 885 |
+
},
|
| 886 |
+
"createTime": {
|
| 887 |
+
"description": "Optional. Time when the operation was created.",
|
| 888 |
+
"format": "google-datetime",
|
| 889 |
+
"type": "string"
|
| 890 |
+
},
|
| 891 |
+
"displayName": {
|
| 892 |
+
"description": "Optional. The display name of the workload.",
|
| 893 |
+
"type": "string"
|
| 894 |
+
},
|
| 895 |
+
"parent": {
|
| 896 |
+
"description": "Optional. The parent of the workload.",
|
| 897 |
+
"type": "string"
|
| 898 |
+
},
|
| 899 |
+
"resourceSettings": {
|
| 900 |
+
"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.",
|
| 901 |
+
"items": {
|
| 902 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings"
|
| 903 |
+
},
|
| 904 |
+
"type": "array"
|
| 905 |
+
}
|
| 906 |
+
},
|
| 907 |
+
"type": "object"
|
| 908 |
+
},
|
| 909 |
+
"GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse": {
|
| 910 |
+
"description": "Response for EnableComplianceUpdates endpoint.",
|
| 911 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse",
|
| 912 |
+
"properties": {},
|
| 913 |
+
"type": "object"
|
| 914 |
+
},
|
| 915 |
+
"GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse": {
|
| 916 |
+
"description": "Response for EnableResourceMonitoring endpoint.",
|
| 917 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse",
|
| 918 |
+
"properties": {},
|
| 919 |
+
"type": "object"
|
| 920 |
+
},
|
| 921 |
+
"GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse": {
|
| 922 |
+
"description": "Response of ListViolations endpoint.",
|
| 923 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse",
|
| 924 |
+
"properties": {
|
| 925 |
+
"nextPageToken": {
|
| 926 |
+
"description": "The next page token. Returns empty if reached the last page.",
|
| 927 |
+
"type": "string"
|
| 928 |
+
},
|
| 929 |
+
"violations": {
|
| 930 |
+
"description": "List of Violations under a Workload.",
|
| 931 |
+
"items": {
|
| 932 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation"
|
| 933 |
+
},
|
| 934 |
+
"type": "array"
|
| 935 |
+
}
|
| 936 |
+
},
|
| 937 |
+
"type": "object"
|
| 938 |
+
},
|
| 939 |
+
"GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse": {
|
| 940 |
+
"description": "Response of listing the compliance updates per workload with pagination.",
|
| 941 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse",
|
| 942 |
+
"properties": {
|
| 943 |
+
"nextPageToken": {
|
| 944 |
+
"description": "The next page token. Return empty if reached the last page.",
|
| 945 |
+
"type": "string"
|
| 946 |
+
},
|
| 947 |
+
"workloadUpdates": {
|
| 948 |
+
"description": "The list of workload updates for a given workload.",
|
| 949 |
+
"items": {
|
| 950 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate"
|
| 951 |
+
},
|
| 952 |
+
"type": "array"
|
| 953 |
+
}
|
| 954 |
+
},
|
| 955 |
+
"type": "object"
|
| 956 |
+
},
|
| 957 |
+
"GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse": {
|
| 958 |
+
"description": "Response of ListWorkloads endpoint.",
|
| 959 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse",
|
| 960 |
+
"properties": {
|
| 961 |
+
"nextPageToken": {
|
| 962 |
+
"description": "The next page token. Return empty if reached the last page.",
|
| 963 |
+
"type": "string"
|
| 964 |
+
},
|
| 965 |
+
"workloads": {
|
| 966 |
+
"description": "List of Workloads under a given parent.",
|
| 967 |
+
"items": {
|
| 968 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
|
| 969 |
+
},
|
| 970 |
+
"type": "array"
|
| 971 |
+
}
|
| 972 |
+
},
|
| 973 |
+
"type": "object"
|
| 974 |
+
},
|
| 975 |
+
"GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup": {
|
| 976 |
+
"description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.",
|
| 977 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup",
|
| 978 |
+
"properties": {
|
| 979 |
+
"analysisResult": {
|
| 980 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisResult",
|
| 981 |
+
"description": "Result of a successful analysis."
|
| 982 |
+
},
|
| 983 |
+
"displayName": {
|
| 984 |
+
"description": "Name of the analysis group.",
|
| 985 |
+
"type": "string"
|
| 986 |
+
},
|
| 987 |
+
"error": {
|
| 988 |
+
"$ref": "GoogleRpcStatus",
|
| 989 |
+
"description": "Error details for a failed analysis."
|
| 990 |
+
}
|
| 991 |
+
},
|
| 992 |
+
"type": "object"
|
| 993 |
+
},
|
| 994 |
+
"GoogleCloudAssuredworkloadsV1beta1MoveAnalysisResult": {
|
| 995 |
+
"description": "Represents the successful move analysis results for a group.",
|
| 996 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisResult",
|
| 997 |
+
"properties": {
|
| 998 |
+
"blockers": {
|
| 999 |
+
"description": "List of blockers. If not resolved, these will result in compliance violations in the target.",
|
| 1000 |
+
"items": {
|
| 1001 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveImpact"
|
| 1002 |
+
},
|
| 1003 |
+
"type": "array"
|
| 1004 |
+
},
|
| 1005 |
+
"warnings": {
|
| 1006 |
+
"description": "List of warnings. These are risks that may or may not result in compliance violations.",
|
| 1007 |
+
"items": {
|
| 1008 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveImpact"
|
| 1009 |
+
},
|
| 1010 |
+
"type": "array"
|
| 1011 |
+
}
|
| 1012 |
+
},
|
| 1013 |
+
"type": "object"
|
| 1014 |
+
},
|
| 1015 |
+
"GoogleCloudAssuredworkloadsV1beta1MoveImpact": {
|
| 1016 |
+
"description": "Represents the impact of moving the asset to the target.",
|
| 1017 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1MoveImpact",
|
| 1018 |
+
"properties": {
|
| 1019 |
+
"detail": {
|
| 1020 |
+
"description": "Explanation of the impact.",
|
| 1021 |
+
"type": "string"
|
| 1022 |
+
}
|
| 1023 |
+
},
|
| 1024 |
+
"type": "object"
|
| 1025 |
+
},
|
| 1026 |
+
"GoogleCloudAssuredworkloadsV1beta1OrgPolicy": {
|
| 1027 |
+
"description": "This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc).",
|
| 1028 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy",
|
| 1029 |
+
"properties": {
|
| 1030 |
+
"constraint": {
|
| 1031 |
+
"description": "The constraint name of the OrgPolicy. e.g. \"constraints/gcp.resourceLocations\".",
|
| 1032 |
+
"type": "string"
|
| 1033 |
+
},
|
| 1034 |
+
"inherit": {
|
| 1035 |
+
"description": "If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited.",
|
| 1036 |
+
"type": "boolean"
|
| 1037 |
+
},
|
| 1038 |
+
"reset": {
|
| 1039 |
+
"description": "Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false.",
|
| 1040 |
+
"type": "boolean"
|
| 1041 |
+
},
|
| 1042 |
+
"resource": {
|
| 1043 |
+
"description": "Resource that the OrgPolicy attaches to. Format: folders/123\" projects/123\".",
|
| 1044 |
+
"type": "string"
|
| 1045 |
+
},
|
| 1046 |
+
"rule": {
|
| 1047 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule",
|
| 1048 |
+
"description": "The rule of the OrgPolicy."
|
| 1049 |
+
}
|
| 1050 |
+
},
|
| 1051 |
+
"type": "object"
|
| 1052 |
+
},
|
| 1053 |
+
"GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule": {
|
| 1054 |
+
"description": "A rule used to express this policy.",
|
| 1055 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule",
|
| 1056 |
+
"properties": {
|
| 1057 |
+
"allowAll": {
|
| 1058 |
+
"description": "ListPolicy only when all values are allowed.",
|
| 1059 |
+
"type": "boolean"
|
| 1060 |
+
},
|
| 1061 |
+
"denyAll": {
|
| 1062 |
+
"description": "ListPolicy only when all values are denied.",
|
| 1063 |
+
"type": "boolean"
|
| 1064 |
+
},
|
| 1065 |
+
"enforce": {
|
| 1066 |
+
"description": "BooleanPolicy only.",
|
| 1067 |
+
"type": "boolean"
|
| 1068 |
+
},
|
| 1069 |
+
"values": {
|
| 1070 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues",
|
| 1071 |
+
"description": "ListPolicy only when custom values are specified."
|
| 1072 |
+
}
|
| 1073 |
+
},
|
| 1074 |
+
"type": "object"
|
| 1075 |
+
},
|
| 1076 |
+
"GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues": {
|
| 1077 |
+
"description": "The values allowed for a ListPolicy.",
|
| 1078 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues",
|
| 1079 |
+
"properties": {
|
| 1080 |
+
"allowedValues": {
|
| 1081 |
+
"description": "List of values allowed at this resource.",
|
| 1082 |
+
"items": {
|
| 1083 |
+
"type": "string"
|
| 1084 |
+
},
|
| 1085 |
+
"type": "array"
|
| 1086 |
+
},
|
| 1087 |
+
"deniedValues": {
|
| 1088 |
+
"description": "List of values denied at this resource.",
|
| 1089 |
+
"items": {
|
| 1090 |
+
"type": "string"
|
| 1091 |
+
},
|
| 1092 |
+
"type": "array"
|
| 1093 |
+
}
|
| 1094 |
+
},
|
| 1095 |
+
"type": "object"
|
| 1096 |
+
},
|
| 1097 |
+
"GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate": {
|
| 1098 |
+
"description": "Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered.",
|
| 1099 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate",
|
| 1100 |
+
"properties": {
|
| 1101 |
+
"appliedPolicy": {
|
| 1102 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy",
|
| 1103 |
+
"description": "The org policy currently applied on the assured workload resource."
|
| 1104 |
+
},
|
| 1105 |
+
"suggestedPolicy": {
|
| 1106 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy",
|
| 1107 |
+
"description": "The suggested org policy that replaces the applied policy."
|
| 1108 |
+
}
|
| 1109 |
+
},
|
| 1110 |
+
"type": "object"
|
| 1111 |
+
},
|
| 1112 |
+
"GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest": {
|
| 1113 |
+
"description": "Request for restricting list of available resources in Workload environment.",
|
| 1114 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest",
|
| 1115 |
+
"properties": {
|
| 1116 |
+
"restrictionType": {
|
| 1117 |
+
"description": "Required. The type of restriction for using gcp products in the Workload environment.",
|
| 1118 |
+
"enum": [
|
| 1119 |
+
"RESTRICTION_TYPE_UNSPECIFIED",
|
| 1120 |
+
"ALLOW_ALL_GCP_RESOURCES",
|
| 1121 |
+
"ALLOW_COMPLIANT_RESOURCES",
|
| 1122 |
+
"APPEND_COMPLIANT_RESOURCES"
|
| 1123 |
+
],
|
| 1124 |
+
"enumDescriptions": [
|
| 1125 |
+
"Unknown restriction type.",
|
| 1126 |
+
"Allow the use all of all gcp products, irrespective of the compliance posture. This effectively removes gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder.",
|
| 1127 |
+
"Based on Workload's compliance regime, allowed list changes. See - https://cloud.google.com/assured-workloads/docs/supported-products for the list of supported resources.",
|
| 1128 |
+
"Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of compliant resources to the existing list of compliant resources. Effective org-policy of the Folder is considered to ensure there is no disruption to the existing customer workflows."
|
| 1129 |
+
],
|
| 1130 |
+
"type": "string"
|
| 1131 |
+
}
|
| 1132 |
+
},
|
| 1133 |
+
"type": "object"
|
| 1134 |
+
},
|
| 1135 |
+
"GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse": {
|
| 1136 |
+
"description": "Response for restricting the list of allowed resources.",
|
| 1137 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse",
|
| 1138 |
+
"properties": {},
|
| 1139 |
+
"type": "object"
|
| 1140 |
+
},
|
| 1141 |
+
"GoogleCloudAssuredworkloadsV1beta1UpdateDetails": {
|
| 1142 |
+
"description": "The details of the update.",
|
| 1143 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails",
|
| 1144 |
+
"properties": {
|
| 1145 |
+
"orgPolicyUpdate": {
|
| 1146 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate",
|
| 1147 |
+
"description": "Update to one org policy, e.g. gcp.resourceLocation."
|
| 1148 |
+
}
|
| 1149 |
+
},
|
| 1150 |
+
"type": "object"
|
| 1151 |
+
},
|
| 1152 |
+
"GoogleCloudAssuredworkloadsV1beta1Violation": {
|
| 1153 |
+
"description": "Workload monitoring Violation.",
|
| 1154 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1Violation",
|
| 1155 |
+
"properties": {
|
| 1156 |
+
"acknowledged": {
|
| 1157 |
+
"description": "A boolean that indicates if the violation is acknowledged",
|
| 1158 |
+
"type": "boolean"
|
| 1159 |
+
},
|
| 1160 |
+
"acknowledgementTime": {
|
| 1161 |
+
"description": "Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false.",
|
| 1162 |
+
"format": "google-datetime",
|
| 1163 |
+
"type": "string"
|
| 1164 |
+
},
|
| 1165 |
+
"associatedOrgPolicyViolationId": {
|
| 1166 |
+
"description": "Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.",
|
| 1167 |
+
"readOnly": true,
|
| 1168 |
+
"type": "string"
|
| 1169 |
+
},
|
| 1170 |
+
"auditLogLink": {
|
| 1171 |
+
"description": "Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}",
|
| 1172 |
+
"readOnly": true,
|
| 1173 |
+
"type": "string"
|
| 1174 |
+
},
|
| 1175 |
+
"beginTime": {
|
| 1176 |
+
"description": "Output only. Time of the event which triggered the Violation.",
|
| 1177 |
+
"format": "google-datetime",
|
| 1178 |
+
"readOnly": true,
|
| 1179 |
+
"type": "string"
|
| 1180 |
+
},
|
| 1181 |
+
"category": {
|
| 1182 |
+
"description": "Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.",
|
| 1183 |
+
"readOnly": true,
|
| 1184 |
+
"type": "string"
|
| 1185 |
+
},
|
| 1186 |
+
"description": {
|
| 1187 |
+
"description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.",
|
| 1188 |
+
"readOnly": true,
|
| 1189 |
+
"type": "string"
|
| 1190 |
+
},
|
| 1191 |
+
"exceptionAuditLogLink": {
|
| 1192 |
+
"description": "Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}",
|
| 1193 |
+
"readOnly": true,
|
| 1194 |
+
"type": "string"
|
| 1195 |
+
},
|
| 1196 |
+
"exceptionContexts": {
|
| 1197 |
+
"description": "Output only. List of all the exception detail added for the violation.",
|
| 1198 |
+
"items": {
|
| 1199 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext"
|
| 1200 |
+
},
|
| 1201 |
+
"readOnly": true,
|
| 1202 |
+
"type": "array"
|
| 1203 |
+
},
|
| 1204 |
+
"name": {
|
| 1205 |
+
"description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}",
|
| 1206 |
+
"readOnly": true,
|
| 1207 |
+
"type": "string"
|
| 1208 |
+
},
|
| 1209 |
+
"nonCompliantOrgPolicy": {
|
| 1210 |
+
"description": "Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}",
|
| 1211 |
+
"readOnly": true,
|
| 1212 |
+
"type": "string"
|
| 1213 |
+
},
|
| 1214 |
+
"orgPolicyConstraint": {
|
| 1215 |
+
"deprecated": true,
|
| 1216 |
+
"description": "Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.",
|
| 1217 |
+
"readOnly": true,
|
| 1218 |
+
"type": "string"
|
| 1219 |
+
},
|
| 1220 |
+
"parentProjectNumber": {
|
| 1221 |
+
"description": "Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.",
|
| 1222 |
+
"readOnly": true,
|
| 1223 |
+
"type": "string"
|
| 1224 |
+
},
|
| 1225 |
+
"remediation": {
|
| 1226 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation",
|
| 1227 |
+
"description": "Output only. Compliance violation remediation",
|
| 1228 |
+
"readOnly": true
|
| 1229 |
+
},
|
| 1230 |
+
"resolveTime": {
|
| 1231 |
+
"description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.",
|
| 1232 |
+
"format": "google-datetime",
|
| 1233 |
+
"readOnly": true,
|
| 1234 |
+
"type": "string"
|
| 1235 |
+
},
|
| 1236 |
+
"resourceName": {
|
| 1237 |
+
"description": "Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.",
|
| 1238 |
+
"readOnly": true,
|
| 1239 |
+
"type": "string"
|
| 1240 |
+
},
|
| 1241 |
+
"resourceType": {
|
| 1242 |
+
"description": "Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.",
|
| 1243 |
+
"readOnly": true,
|
| 1244 |
+
"type": "string"
|
| 1245 |
+
},
|
| 1246 |
+
"state": {
|
| 1247 |
+
"description": "Output only. State of the violation",
|
| 1248 |
+
"enum": [
|
| 1249 |
+
"STATE_UNSPECIFIED",
|
| 1250 |
+
"RESOLVED",
|
| 1251 |
+
"UNRESOLVED",
|
| 1252 |
+
"EXCEPTION"
|
| 1253 |
+
],
|
| 1254 |
+
"enumDescriptions": [
|
| 1255 |
+
"Unspecified state.",
|
| 1256 |
+
"Violation is resolved.",
|
| 1257 |
+
"Violation is Unresolved",
|
| 1258 |
+
"Violation is Exception"
|
| 1259 |
+
],
|
| 1260 |
+
"readOnly": true,
|
| 1261 |
+
"type": "string"
|
| 1262 |
+
},
|
| 1263 |
+
"updateTime": {
|
| 1264 |
+
"description": "Output only. The last time when the Violation record was updated.",
|
| 1265 |
+
"format": "google-datetime",
|
| 1266 |
+
"readOnly": true,
|
| 1267 |
+
"type": "string"
|
| 1268 |
+
},
|
| 1269 |
+
"violationType": {
|
| 1270 |
+
"description": "Output only. Type of the violation",
|
| 1271 |
+
"enum": [
|
| 1272 |
+
"VIOLATION_TYPE_UNSPECIFIED",
|
| 1273 |
+
"ORG_POLICY",
|
| 1274 |
+
"RESOURCE"
|
| 1275 |
+
],
|
| 1276 |
+
"enumDescriptions": [
|
| 1277 |
+
"Unspecified type.",
|
| 1278 |
+
"Org Policy Violation.",
|
| 1279 |
+
"Resource Violation."
|
| 1280 |
+
],
|
| 1281 |
+
"readOnly": true,
|
| 1282 |
+
"type": "string"
|
| 1283 |
+
}
|
| 1284 |
+
},
|
| 1285 |
+
"type": "object"
|
| 1286 |
+
},
|
| 1287 |
+
"GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext": {
|
| 1288 |
+
"description": "Violation exception detail.",
|
| 1289 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext",
|
| 1290 |
+
"properties": {
|
| 1291 |
+
"acknowledgementTime": {
|
| 1292 |
+
"description": "Timestamp when the violation was acknowledged.",
|
| 1293 |
+
"format": "google-datetime",
|
| 1294 |
+
"type": "string"
|
| 1295 |
+
},
|
| 1296 |
+
"comment": {
|
| 1297 |
+
"description": "Business justification provided towards the acknowledgement of the violation.",
|
| 1298 |
+
"type": "string"
|
| 1299 |
+
},
|
| 1300 |
+
"userName": {
|
| 1301 |
+
"description": "Name of the user (or service account) who acknowledged the violation.",
|
| 1302 |
+
"type": "string"
|
| 1303 |
+
}
|
| 1304 |
+
},
|
| 1305 |
+
"type": "object"
|
| 1306 |
+
},
|
| 1307 |
+
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediation": {
|
| 1308 |
+
"description": "Represents remediation guidance to resolve compliance violation for AssuredWorkload",
|
| 1309 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation",
|
| 1310 |
+
"properties": {
|
| 1311 |
+
"compliantValues": {
|
| 1312 |
+
"description": "Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values",
|
| 1313 |
+
"items": {
|
| 1314 |
+
"type": "string"
|
| 1315 |
+
},
|
| 1316 |
+
"type": "array"
|
| 1317 |
+
},
|
| 1318 |
+
"instructions": {
|
| 1319 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions",
|
| 1320 |
+
"description": "Required. Remediation instructions to resolve violations"
|
| 1321 |
+
},
|
| 1322 |
+
"remediationType": {
|
| 1323 |
+
"description": "Output only. Reemediation type based on the type of org policy values violated",
|
| 1324 |
+
"enum": [
|
| 1325 |
+
"REMEDIATION_TYPE_UNSPECIFIED",
|
| 1326 |
+
"REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION",
|
| 1327 |
+
"REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION",
|
| 1328 |
+
"REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION",
|
| 1329 |
+
"REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION",
|
| 1330 |
+
"REMEDIATION_RESOURCE_VIOLATION",
|
| 1331 |
+
"REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES"
|
| 1332 |
+
],
|
| 1333 |
+
"enumDescriptions": [
|
| 1334 |
+
"Unspecified remediation type",
|
| 1335 |
+
"Remediation type for boolean org policy",
|
| 1336 |
+
"Remediation type for list org policy which have allowed values in the monitoring rule",
|
| 1337 |
+
"Remediation type for list org policy which have denied values in the monitoring rule",
|
| 1338 |
+
"Remediation type for gcp.restrictCmekCryptoKeyProjects",
|
| 1339 |
+
"Remediation type for resource violation.",
|
| 1340 |
+
"Remediation type for resource violation due to gcp.restrictNonCmekServices"
|
| 1341 |
+
],
|
| 1342 |
+
"readOnly": true,
|
| 1343 |
+
"type": "string"
|
| 1344 |
+
}
|
| 1345 |
+
},
|
| 1346 |
+
"type": "object"
|
| 1347 |
+
},
|
| 1348 |
+
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions": {
|
| 1349 |
+
"description": "Instructions to remediate violation",
|
| 1350 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions",
|
| 1351 |
+
"properties": {
|
| 1352 |
+
"consoleInstructions": {
|
| 1353 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole",
|
| 1354 |
+
"description": "Remediation instructions to resolve violation via cloud console"
|
| 1355 |
+
},
|
| 1356 |
+
"gcloudInstructions": {
|
| 1357 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud",
|
| 1358 |
+
"description": "Remediation instructions to resolve violation via gcloud cli"
|
| 1359 |
+
}
|
| 1360 |
+
},
|
| 1361 |
+
"type": "object"
|
| 1362 |
+
},
|
| 1363 |
+
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole": {
|
| 1364 |
+
"description": "Remediation instructions to resolve violation via cloud console",
|
| 1365 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole",
|
| 1366 |
+
"properties": {
|
| 1367 |
+
"additionalLinks": {
|
| 1368 |
+
"description": "Additional urls for more information about steps",
|
| 1369 |
+
"items": {
|
| 1370 |
+
"type": "string"
|
| 1371 |
+
},
|
| 1372 |
+
"type": "array"
|
| 1373 |
+
},
|
| 1374 |
+
"consoleUris": {
|
| 1375 |
+
"description": "Link to console page where violations can be resolved",
|
| 1376 |
+
"items": {
|
| 1377 |
+
"type": "string"
|
| 1378 |
+
},
|
| 1379 |
+
"type": "array"
|
| 1380 |
+
},
|
| 1381 |
+
"steps": {
|
| 1382 |
+
"description": "Steps to resolve violation via cloud console",
|
| 1383 |
+
"items": {
|
| 1384 |
+
"type": "string"
|
| 1385 |
+
},
|
| 1386 |
+
"type": "array"
|
| 1387 |
+
}
|
| 1388 |
+
},
|
| 1389 |
+
"type": "object"
|
| 1390 |
+
},
|
| 1391 |
+
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud": {
|
| 1392 |
+
"description": "Remediation instructions to resolve violation via gcloud cli",
|
| 1393 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud",
|
| 1394 |
+
"properties": {
|
| 1395 |
+
"additionalLinks": {
|
| 1396 |
+
"description": "Additional urls for more information about steps",
|
| 1397 |
+
"items": {
|
| 1398 |
+
"type": "string"
|
| 1399 |
+
},
|
| 1400 |
+
"type": "array"
|
| 1401 |
+
},
|
| 1402 |
+
"gcloudCommands": {
|
| 1403 |
+
"description": "Gcloud command to resolve violation",
|
| 1404 |
+
"items": {
|
| 1405 |
+
"type": "string"
|
| 1406 |
+
},
|
| 1407 |
+
"type": "array"
|
| 1408 |
+
},
|
| 1409 |
+
"steps": {
|
| 1410 |
+
"description": "Steps to resolve violation via gcloud cli",
|
| 1411 |
+
"items": {
|
| 1412 |
+
"type": "string"
|
| 1413 |
+
},
|
| 1414 |
+
"type": "array"
|
| 1415 |
+
}
|
| 1416 |
+
},
|
| 1417 |
+
"type": "object"
|
| 1418 |
+
},
|
| 1419 |
+
"GoogleCloudAssuredworkloadsV1beta1Workload": {
|
| 1420 |
+
"description": "A Workload object for managing highly regulated workloads of cloud customers.",
|
| 1421 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1Workload",
|
| 1422 |
+
"properties": {
|
| 1423 |
+
"availableUpdates": {
|
| 1424 |
+
"description": "Output only. The number of updates available for the workload.",
|
| 1425 |
+
"format": "int32",
|
| 1426 |
+
"readOnly": true,
|
| 1427 |
+
"type": "integer"
|
| 1428 |
+
},
|
| 1429 |
+
"billingAccount": {
|
| 1430 |
+
"description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
|
| 1431 |
+
"type": "string"
|
| 1432 |
+
},
|
| 1433 |
+
"cjisSettings": {
|
| 1434 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings",
|
| 1435 |
+
"deprecated": true,
|
| 1436 |
+
"description": "Input only. Immutable. Settings specific to resources needed for CJIS."
|
| 1437 |
+
},
|
| 1438 |
+
"complianceRegime": {
|
| 1439 |
+
"description": "Required. Immutable. Compliance Regime associated with this workload.",
|
| 1440 |
+
"enum": [
|
| 1441 |
+
"COMPLIANCE_REGIME_UNSPECIFIED",
|
| 1442 |
+
"IL4",
|
| 1443 |
+
"CJIS",
|
| 1444 |
+
"FEDRAMP_HIGH",
|
| 1445 |
+
"FEDRAMP_MODERATE",
|
| 1446 |
+
"US_REGIONAL_ACCESS",
|
| 1447 |
+
"HIPAA",
|
| 1448 |
+
"HITRUST",
|
| 1449 |
+
"EU_REGIONS_AND_SUPPORT",
|
| 1450 |
+
"CA_REGIONS_AND_SUPPORT",
|
| 1451 |
+
"ITAR",
|
| 1452 |
+
"AU_REGIONS_AND_US_SUPPORT",
|
| 1453 |
+
"ASSURED_WORKLOADS_FOR_PARTNERS",
|
| 1454 |
+
"ISR_REGIONS",
|
| 1455 |
+
"ISR_REGIONS_AND_SUPPORT",
|
| 1456 |
+
"CA_PROTECTED_B",
|
| 1457 |
+
"IL5",
|
| 1458 |
+
"IL2",
|
| 1459 |
+
"JP_REGIONS_AND_SUPPORT",
|
| 1460 |
+
"KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS",
|
| 1461 |
+
"REGIONAL_CONTROLS",
|
| 1462 |
+
"HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS",
|
| 1463 |
+
"HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT",
|
| 1464 |
+
"IRS_1075",
|
| 1465 |
+
"CANADA_CONTROLLED_GOODS"
|
| 1466 |
+
],
|
| 1467 |
+
"enumDeprecated": [
|
| 1468 |
+
false,
|
| 1469 |
+
false,
|
| 1470 |
+
false,
|
| 1471 |
+
false,
|
| 1472 |
+
false,
|
| 1473 |
+
false,
|
| 1474 |
+
true,
|
| 1475 |
+
true,
|
| 1476 |
+
false,
|
| 1477 |
+
false,
|
| 1478 |
+
false,
|
| 1479 |
+
false,
|
| 1480 |
+
false,
|
| 1481 |
+
false,
|
| 1482 |
+
false,
|
| 1483 |
+
false,
|
| 1484 |
+
false,
|
| 1485 |
+
false,
|
| 1486 |
+
false,
|
| 1487 |
+
false,
|
| 1488 |
+
false,
|
| 1489 |
+
false,
|
| 1490 |
+
false,
|
| 1491 |
+
false,
|
| 1492 |
+
false
|
| 1493 |
+
],
|
| 1494 |
+
"enumDescriptions": [
|
| 1495 |
+
"Unknown compliance regime.",
|
| 1496 |
+
"Information protection as per DoD IL4 requirements.",
|
| 1497 |
+
"Criminal Justice Information Services (CJIS) Security policies.",
|
| 1498 |
+
"FedRAMP High data protection controls",
|
| 1499 |
+
"FedRAMP Moderate data protection controls",
|
| 1500 |
+
"Assured Workloads For US Regions data protection controls",
|
| 1501 |
+
"[DEPRECATED] Health Insurance Portability and Accountability Act controls",
|
| 1502 |
+
"[DEPRECATED] Health Information Trust Alliance controls",
|
| 1503 |
+
"Assured Workloads For EU Regions and Support controls",
|
| 1504 |
+
"Assured Workloads For Canada Regions and Support controls",
|
| 1505 |
+
"International Traffic in Arms Regulations",
|
| 1506 |
+
"Assured Workloads for Australia Regions and Support controls",
|
| 1507 |
+
"Assured Workloads for Partners;",
|
| 1508 |
+
"Assured Workloads for Israel Regions",
|
| 1509 |
+
"Assured Workloads for Israel Regions",
|
| 1510 |
+
"Assured Workloads for Canada Protected B regime",
|
| 1511 |
+
"Information protection as per DoD IL5 requirements.",
|
| 1512 |
+
"Information protection as per DoD IL2 requirements.",
|
| 1513 |
+
"Assured Workloads for Japan Regions",
|
| 1514 |
+
"Assured Workloads Sovereign Controls KSA",
|
| 1515 |
+
"Assured Workloads for Regional Controls",
|
| 1516 |
+
"Healthcare and Life Science Controls",
|
| 1517 |
+
"Healthcare and Life Science Controls with US Support",
|
| 1518 |
+
"Internal Revenue Service 1075 controls",
|
| 1519 |
+
"Canada Controlled Goods"
|
| 1520 |
+
],
|
| 1521 |
+
"type": "string"
|
| 1522 |
+
},
|
| 1523 |
+
"complianceStatus": {
|
| 1524 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus",
|
| 1525 |
+
"description": "Output only. Count of active Violations in the Workload.",
|
| 1526 |
+
"readOnly": true
|
| 1527 |
+
},
|
| 1528 |
+
"complianceUpdatesEnabled": {
|
| 1529 |
+
"description": "Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.",
|
| 1530 |
+
"readOnly": true,
|
| 1531 |
+
"type": "boolean"
|
| 1532 |
+
},
|
| 1533 |
+
"compliantButDisallowedServices": {
|
| 1534 |
+
"description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.",
|
| 1535 |
+
"items": {
|
| 1536 |
+
"type": "string"
|
| 1537 |
+
},
|
| 1538 |
+
"readOnly": true,
|
| 1539 |
+
"type": "array"
|
| 1540 |
+
},
|
| 1541 |
+
"createTime": {
|
| 1542 |
+
"description": "Output only. Immutable. The Workload creation timestamp.",
|
| 1543 |
+
"format": "google-datetime",
|
| 1544 |
+
"readOnly": true,
|
| 1545 |
+
"type": "string"
|
| 1546 |
+
},
|
| 1547 |
+
"displayName": {
|
| 1548 |
+
"description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload",
|
| 1549 |
+
"type": "string"
|
| 1550 |
+
},
|
| 1551 |
+
"ekmProvisioningResponse": {
|
| 1552 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadEkmProvisioningResponse",
|
| 1553 |
+
"description": "Output only. Represents the Ekm Provisioning State of the given workload.",
|
| 1554 |
+
"readOnly": true
|
| 1555 |
+
},
|
| 1556 |
+
"enableSovereignControls": {
|
| 1557 |
+
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
|
| 1558 |
+
"type": "boolean"
|
| 1559 |
+
},
|
| 1560 |
+
"etag": {
|
| 1561 |
+
"description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.",
|
| 1562 |
+
"type": "string"
|
| 1563 |
+
},
|
| 1564 |
+
"fedrampHighSettings": {
|
| 1565 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings",
|
| 1566 |
+
"deprecated": true,
|
| 1567 |
+
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP High."
|
| 1568 |
+
},
|
| 1569 |
+
"fedrampModerateSettings": {
|
| 1570 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings",
|
| 1571 |
+
"deprecated": true,
|
| 1572 |
+
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate."
|
| 1573 |
+
},
|
| 1574 |
+
"il4Settings": {
|
| 1575 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings",
|
| 1576 |
+
"deprecated": true,
|
| 1577 |
+
"description": "Input only. Immutable. Settings specific to resources needed for IL4."
|
| 1578 |
+
},
|
| 1579 |
+
"kajEnrollmentState": {
|
| 1580 |
+
"description": "Output only. Represents the KAJ enrollment state of the given workload.",
|
| 1581 |
+
"enum": [
|
| 1582 |
+
"KAJ_ENROLLMENT_STATE_UNSPECIFIED",
|
| 1583 |
+
"KAJ_ENROLLMENT_STATE_PENDING",
|
| 1584 |
+
"KAJ_ENROLLMENT_STATE_COMPLETE"
|
| 1585 |
+
],
|
| 1586 |
+
"enumDescriptions": [
|
| 1587 |
+
"Default State for KAJ Enrollment.",
|
| 1588 |
+
"Pending State for KAJ Enrollment.",
|
| 1589 |
+
"Complete State for KAJ Enrollment."
|
| 1590 |
+
],
|
| 1591 |
+
"readOnly": true,
|
| 1592 |
+
"type": "string"
|
| 1593 |
+
},
|
| 1594 |
+
"kmsSettings": {
|
| 1595 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1596 |
+
"deprecated": true,
|
| 1597 |
+
"description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field."
|
| 1598 |
+
},
|
| 1599 |
+
"labels": {
|
| 1600 |
+
"additionalProperties": {
|
| 1601 |
+
"type": "string"
|
| 1602 |
+
},
|
| 1603 |
+
"description": "Optional. Labels applied to the workload.",
|
| 1604 |
+
"type": "object"
|
| 1605 |
+
},
|
| 1606 |
+
"name": {
|
| 1607 |
+
"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.",
|
| 1608 |
+
"type": "string"
|
| 1609 |
+
},
|
| 1610 |
+
"partner": {
|
| 1611 |
+
"description": "Optional. Partner regime associated with this workload.",
|
| 1612 |
+
"enum": [
|
| 1613 |
+
"PARTNER_UNSPECIFIED",
|
| 1614 |
+
"LOCAL_CONTROLS_BY_S3NS",
|
| 1615 |
+
"SOVEREIGN_CONTROLS_BY_T_SYSTEMS",
|
| 1616 |
+
"SOVEREIGN_CONTROLS_BY_SIA_MINSAIT",
|
| 1617 |
+
"SOVEREIGN_CONTROLS_BY_PSN",
|
| 1618 |
+
"SOVEREIGN_CONTROLS_BY_CNTXT",
|
| 1619 |
+
"SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM"
|
| 1620 |
+
],
|
| 1621 |
+
"enumDescriptions": [
|
| 1622 |
+
"",
|
| 1623 |
+
"Enum representing S3NS (Thales) partner.",
|
| 1624 |
+
"Enum representing T_SYSTEM (TSI) partner.",
|
| 1625 |
+
"Enum representing SIA_MINSAIT (Indra) partner.",
|
| 1626 |
+
"Enum representing PSN (TIM) partner.",
|
| 1627 |
+
"Enum representing CNTXT (Kingdom of Saudi Arabia) partner.",
|
| 1628 |
+
"Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering without EKM."
|
| 1629 |
+
],
|
| 1630 |
+
"type": "string"
|
| 1631 |
+
},
|
| 1632 |
+
"partnerPermissions": {
|
| 1633 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions",
|
| 1634 |
+
"description": "Optional. Permissions granted to the AW Partner SA account for the customer workload"
|
| 1635 |
+
},
|
| 1636 |
+
"partnerServicesBillingAccount": {
|
| 1637 |
+
"description": "Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC",
|
| 1638 |
+
"type": "string"
|
| 1639 |
+
},
|
| 1640 |
+
"provisionedResourcesParent": {
|
| 1641 |
+
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}",
|
| 1642 |
+
"type": "string"
|
| 1643 |
+
},
|
| 1644 |
+
"resourceMonitoringEnabled": {
|
| 1645 |
+
"description": "Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.",
|
| 1646 |
+
"readOnly": true,
|
| 1647 |
+
"type": "boolean"
|
| 1648 |
+
},
|
| 1649 |
+
"resourceSettings": {
|
| 1650 |
+
"description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.",
|
| 1651 |
+
"items": {
|
| 1652 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings"
|
| 1653 |
+
},
|
| 1654 |
+
"type": "array"
|
| 1655 |
+
},
|
| 1656 |
+
"resources": {
|
| 1657 |
+
"description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.",
|
| 1658 |
+
"items": {
|
| 1659 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo"
|
| 1660 |
+
},
|
| 1661 |
+
"readOnly": true,
|
| 1662 |
+
"type": "array"
|
| 1663 |
+
},
|
| 1664 |
+
"saaEnrollmentResponse": {
|
| 1665 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse",
|
| 1666 |
+
"description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.",
|
| 1667 |
+
"readOnly": true
|
| 1668 |
+
},
|
| 1669 |
+
"violationNotificationsEnabled": {
|
| 1670 |
+
"description": "Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.",
|
| 1671 |
+
"type": "boolean"
|
| 1672 |
+
},
|
| 1673 |
+
"workloadOptions": {
|
| 1674 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadWorkloadOptions",
|
| 1675 |
+
"description": "Optional. Options to be set for the given created workload."
|
| 1676 |
+
}
|
| 1677 |
+
},
|
| 1678 |
+
"type": "object"
|
| 1679 |
+
},
|
| 1680 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings": {
|
| 1681 |
+
"deprecated": true,
|
| 1682 |
+
"description": "Settings specific to resources needed for CJIS.",
|
| 1683 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings",
|
| 1684 |
+
"properties": {
|
| 1685 |
+
"kmsSettings": {
|
| 1686 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1687 |
+
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
|
| 1688 |
+
}
|
| 1689 |
+
},
|
| 1690 |
+
"type": "object"
|
| 1691 |
+
},
|
| 1692 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus": {
|
| 1693 |
+
"description": "Represents the Compliance Status of this workload",
|
| 1694 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus",
|
| 1695 |
+
"properties": {
|
| 1696 |
+
"acknowledgedResourceViolationCount": {
|
| 1697 |
+
"description": "Number of current resource violations which are not acknowledged.",
|
| 1698 |
+
"format": "int32",
|
| 1699 |
+
"type": "integer"
|
| 1700 |
+
},
|
| 1701 |
+
"acknowledgedViolationCount": {
|
| 1702 |
+
"description": "Number of current orgPolicy violations which are acknowledged.",
|
| 1703 |
+
"format": "int32",
|
| 1704 |
+
"type": "integer"
|
| 1705 |
+
},
|
| 1706 |
+
"activeResourceViolationCount": {
|
| 1707 |
+
"description": "Number of current resource violations which are acknowledged.",
|
| 1708 |
+
"format": "int32",
|
| 1709 |
+
"type": "integer"
|
| 1710 |
+
},
|
| 1711 |
+
"activeViolationCount": {
|
| 1712 |
+
"description": "Number of current orgPolicy violations which are not acknowledged.",
|
| 1713 |
+
"format": "int32",
|
| 1714 |
+
"type": "integer"
|
| 1715 |
+
}
|
| 1716 |
+
},
|
| 1717 |
+
"type": "object"
|
| 1718 |
+
},
|
| 1719 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadEkmProvisioningResponse": {
|
| 1720 |
+
"description": "External key management systems(EKM) Provisioning response",
|
| 1721 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadEkmProvisioningResponse",
|
| 1722 |
+
"properties": {
|
| 1723 |
+
"ekmProvisioningErrorDomain": {
|
| 1724 |
+
"description": "Indicates Ekm provisioning error if any.",
|
| 1725 |
+
"enum": [
|
| 1726 |
+
"EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED",
|
| 1727 |
+
"UNSPECIFIED_ERROR",
|
| 1728 |
+
"GOOGLE_SERVER_ERROR",
|
| 1729 |
+
"EXTERNAL_USER_ERROR",
|
| 1730 |
+
"EXTERNAL_PARTNER_ERROR",
|
| 1731 |
+
"TIMEOUT_ERROR"
|
| 1732 |
+
],
|
| 1733 |
+
"enumDescriptions": [
|
| 1734 |
+
"No error domain",
|
| 1735 |
+
"Error but domain is unspecified.",
|
| 1736 |
+
"Internal logic breaks within provisioning code.",
|
| 1737 |
+
"Error occurred with the customer not granting permission/creating resource.",
|
| 1738 |
+
"Error occurred within the partner's provisioning cluster.",
|
| 1739 |
+
"Resource wasn't provisioned in the required 7 day time period"
|
| 1740 |
+
],
|
| 1741 |
+
"type": "string"
|
| 1742 |
+
},
|
| 1743 |
+
"ekmProvisioningErrorMapping": {
|
| 1744 |
+
"description": "Detailed error message if Ekm provisioning fails",
|
| 1745 |
+
"enum": [
|
| 1746 |
+
"EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED",
|
| 1747 |
+
"INVALID_SERVICE_ACCOUNT",
|
| 1748 |
+
"MISSING_METRICS_SCOPE_ADMIN_PERMISSION",
|
| 1749 |
+
"MISSING_EKM_CONNECTION_ADMIN_PERMISSION"
|
| 1750 |
+
],
|
| 1751 |
+
"enumDescriptions": [
|
| 1752 |
+
"Error is unspecified.",
|
| 1753 |
+
"Service account is used is invalid.",
|
| 1754 |
+
"Iam permission monitoring.MetricsScopeAdmin wasn't applied.",
|
| 1755 |
+
"Iam permission cloudkms.ekmConnectionsAdmin wasn't applied."
|
| 1756 |
+
],
|
| 1757 |
+
"type": "string"
|
| 1758 |
+
},
|
| 1759 |
+
"ekmProvisioningState": {
|
| 1760 |
+
"description": "Output only. Indicates Ekm enrollment Provisioning of a given workload.",
|
| 1761 |
+
"enum": [
|
| 1762 |
+
"EKM_PROVISIONING_STATE_UNSPECIFIED",
|
| 1763 |
+
"EKM_PROVISIONING_STATE_PENDING",
|
| 1764 |
+
"EKM_PROVISIONING_STATE_FAILED",
|
| 1765 |
+
"EKM_PROVISIONING_STATE_COMPLETED"
|
| 1766 |
+
],
|
| 1767 |
+
"enumDescriptions": [
|
| 1768 |
+
"Default State for Ekm Provisioning",
|
| 1769 |
+
"Pending State for Ekm Provisioning",
|
| 1770 |
+
"Failed State for Ekm Provisioning",
|
| 1771 |
+
"Completed State for Ekm Provisioning"
|
| 1772 |
+
],
|
| 1773 |
+
"readOnly": true,
|
| 1774 |
+
"type": "string"
|
| 1775 |
+
}
|
| 1776 |
+
},
|
| 1777 |
+
"type": "object"
|
| 1778 |
+
},
|
| 1779 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings": {
|
| 1780 |
+
"deprecated": true,
|
| 1781 |
+
"description": "Settings specific to resources needed for FedRAMP High.",
|
| 1782 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings",
|
| 1783 |
+
"properties": {
|
| 1784 |
+
"kmsSettings": {
|
| 1785 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1786 |
+
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
|
| 1787 |
+
}
|
| 1788 |
+
},
|
| 1789 |
+
"type": "object"
|
| 1790 |
+
},
|
| 1791 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings": {
|
| 1792 |
+
"deprecated": true,
|
| 1793 |
+
"description": "Settings specific to resources needed for FedRAMP Moderate.",
|
| 1794 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings",
|
| 1795 |
+
"properties": {
|
| 1796 |
+
"kmsSettings": {
|
| 1797 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1798 |
+
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
|
| 1799 |
+
}
|
| 1800 |
+
},
|
| 1801 |
+
"type": "object"
|
| 1802 |
+
},
|
| 1803 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings": {
|
| 1804 |
+
"deprecated": true,
|
| 1805 |
+
"description": "Settings specific to resources needed for IL4.",
|
| 1806 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings",
|
| 1807 |
+
"properties": {
|
| 1808 |
+
"kmsSettings": {
|
| 1809 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1810 |
+
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
|
| 1811 |
+
}
|
| 1812 |
+
},
|
| 1813 |
+
"type": "object"
|
| 1814 |
+
},
|
| 1815 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings": {
|
| 1816 |
+
"deprecated": true,
|
| 1817 |
+
"description": "Settings specific to the Key Management Service.",
|
| 1818 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
|
| 1819 |
+
"properties": {
|
| 1820 |
+
"nextRotationTime": {
|
| 1821 |
+
"description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.",
|
| 1822 |
+
"format": "google-datetime",
|
| 1823 |
+
"type": "string"
|
| 1824 |
+
},
|
| 1825 |
+
"rotationPeriod": {
|
| 1826 |
+
"description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.",
|
| 1827 |
+
"format": "google-duration",
|
| 1828 |
+
"type": "string"
|
| 1829 |
+
}
|
| 1830 |
+
},
|
| 1831 |
+
"type": "object"
|
| 1832 |
+
},
|
| 1833 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions": {
|
| 1834 |
+
"description": "Permissions granted to the AW Partner SA account for the customer workload",
|
| 1835 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions",
|
| 1836 |
+
"properties": {
|
| 1837 |
+
"accessTransparencyLogsSupportCaseViewer": {
|
| 1838 |
+
"description": "Optional. Allow partner to view support case details for an AXT log",
|
| 1839 |
+
"type": "boolean"
|
| 1840 |
+
},
|
| 1841 |
+
"assuredWorkloadsMonitoring": {
|
| 1842 |
+
"description": "Optional. Allow partner to view violation alerts.",
|
| 1843 |
+
"type": "boolean"
|
| 1844 |
+
},
|
| 1845 |
+
"dataLogsViewer": {
|
| 1846 |
+
"description": "Optional. Allow the partner to view inspectability logs and monitoring violations.",
|
| 1847 |
+
"type": "boolean"
|
| 1848 |
+
},
|
| 1849 |
+
"serviceAccessApprover": {
|
| 1850 |
+
"description": "Optional. Allow partner to view access approval logs.",
|
| 1851 |
+
"type": "boolean"
|
| 1852 |
+
}
|
| 1853 |
+
},
|
| 1854 |
+
"type": "object"
|
| 1855 |
+
},
|
| 1856 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo": {
|
| 1857 |
+
"description": "Represent the resources that are children of this Workload.",
|
| 1858 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo",
|
| 1859 |
+
"properties": {
|
| 1860 |
+
"resourceId": {
|
| 1861 |
+
"description": "Output only. Resource identifier. For a project this represents project_number.",
|
| 1862 |
+
"format": "int64",
|
| 1863 |
+
"readOnly": true,
|
| 1864 |
+
"type": "string"
|
| 1865 |
+
},
|
| 1866 |
+
"resourceType": {
|
| 1867 |
+
"description": "Indicates the type of resource.",
|
| 1868 |
+
"enum": [
|
| 1869 |
+
"RESOURCE_TYPE_UNSPECIFIED",
|
| 1870 |
+
"CONSUMER_PROJECT",
|
| 1871 |
+
"CONSUMER_FOLDER",
|
| 1872 |
+
"ENCRYPTION_KEYS_PROJECT",
|
| 1873 |
+
"KEYRING"
|
| 1874 |
+
],
|
| 1875 |
+
"enumDeprecated": [
|
| 1876 |
+
false,
|
| 1877 |
+
true,
|
| 1878 |
+
false,
|
| 1879 |
+
false,
|
| 1880 |
+
false
|
| 1881 |
+
],
|
| 1882 |
+
"enumDescriptions": [
|
| 1883 |
+
"Unknown resource type.",
|
| 1884 |
+
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
|
| 1885 |
+
"Consumer Folder.",
|
| 1886 |
+
"Consumer project containing encryption keys.",
|
| 1887 |
+
"Keyring resource that hosts encryption keys."
|
| 1888 |
+
],
|
| 1889 |
+
"type": "string"
|
| 1890 |
+
}
|
| 1891 |
+
},
|
| 1892 |
+
"type": "object"
|
| 1893 |
+
},
|
| 1894 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings": {
|
| 1895 |
+
"description": "Represent the custom settings for the resources to be created.",
|
| 1896 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings",
|
| 1897 |
+
"properties": {
|
| 1898 |
+
"displayName": {
|
| 1899 |
+
"description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.",
|
| 1900 |
+
"type": "string"
|
| 1901 |
+
},
|
| 1902 |
+
"resourceId": {
|
| 1903 |
+
"description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.",
|
| 1904 |
+
"type": "string"
|
| 1905 |
+
},
|
| 1906 |
+
"resourceType": {
|
| 1907 |
+
"description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)",
|
| 1908 |
+
"enum": [
|
| 1909 |
+
"RESOURCE_TYPE_UNSPECIFIED",
|
| 1910 |
+
"CONSUMER_PROJECT",
|
| 1911 |
+
"CONSUMER_FOLDER",
|
| 1912 |
+
"ENCRYPTION_KEYS_PROJECT",
|
| 1913 |
+
"KEYRING"
|
| 1914 |
+
],
|
| 1915 |
+
"enumDeprecated": [
|
| 1916 |
+
false,
|
| 1917 |
+
true,
|
| 1918 |
+
false,
|
| 1919 |
+
false,
|
| 1920 |
+
false
|
| 1921 |
+
],
|
| 1922 |
+
"enumDescriptions": [
|
| 1923 |
+
"Unknown resource type.",
|
| 1924 |
+
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
|
| 1925 |
+
"Consumer Folder.",
|
| 1926 |
+
"Consumer project containing encryption keys.",
|
| 1927 |
+
"Keyring resource that hosts encryption keys."
|
| 1928 |
+
],
|
| 1929 |
+
"type": "string"
|
| 1930 |
+
}
|
| 1931 |
+
},
|
| 1932 |
+
"type": "object"
|
| 1933 |
+
},
|
| 1934 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse": {
|
| 1935 |
+
"description": "Signed Access Approvals (SAA) enrollment response.",
|
| 1936 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse",
|
| 1937 |
+
"properties": {
|
| 1938 |
+
"setupErrors": {
|
| 1939 |
+
"description": "Indicates SAA enrollment setup error if any.",
|
| 1940 |
+
"items": {
|
| 1941 |
+
"enum": [
|
| 1942 |
+
"SETUP_ERROR_UNSPECIFIED",
|
| 1943 |
+
"ERROR_INVALID_BASE_SETUP",
|
| 1944 |
+
"ERROR_MISSING_EXTERNAL_SIGNING_KEY",
|
| 1945 |
+
"ERROR_NOT_ALL_SERVICES_ENROLLED",
|
| 1946 |
+
"ERROR_SETUP_CHECK_FAILED"
|
| 1947 |
+
],
|
| 1948 |
+
"enumDescriptions": [
|
| 1949 |
+
"Unspecified.",
|
| 1950 |
+
"Invalid states for all customers, to be redirected to AA UI for additional details.",
|
| 1951 |
+
"Returned when there is not an EKM key configured.",
|
| 1952 |
+
"Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.",
|
| 1953 |
+
"Returned when exception was encountered during evaluation of other criteria."
|
| 1954 |
+
],
|
| 1955 |
+
"type": "string"
|
| 1956 |
+
},
|
| 1957 |
+
"type": "array"
|
| 1958 |
+
},
|
| 1959 |
+
"setupStatus": {
|
| 1960 |
+
"description": "Output only. Indicates SAA enrollment status of a given workload.",
|
| 1961 |
+
"enum": [
|
| 1962 |
+
"SETUP_STATE_UNSPECIFIED",
|
| 1963 |
+
"STATUS_PENDING",
|
| 1964 |
+
"STATUS_COMPLETE"
|
| 1965 |
+
],
|
| 1966 |
+
"enumDescriptions": [
|
| 1967 |
+
"Unspecified.",
|
| 1968 |
+
"SAA enrollment pending.",
|
| 1969 |
+
"SAA enrollment comopleted."
|
| 1970 |
+
],
|
| 1971 |
+
"readOnly": true,
|
| 1972 |
+
"type": "string"
|
| 1973 |
+
}
|
| 1974 |
+
},
|
| 1975 |
+
"type": "object"
|
| 1976 |
+
},
|
| 1977 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate": {
|
| 1978 |
+
"description": "A workload update is a change to the workload's compliance configuration.",
|
| 1979 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate",
|
| 1980 |
+
"properties": {
|
| 1981 |
+
"createTime": {
|
| 1982 |
+
"description": "The time the update was created.",
|
| 1983 |
+
"format": "google-datetime",
|
| 1984 |
+
"type": "string"
|
| 1985 |
+
},
|
| 1986 |
+
"details": {
|
| 1987 |
+
"$ref": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails",
|
| 1988 |
+
"description": "The details of the update."
|
| 1989 |
+
},
|
| 1990 |
+
"name": {
|
| 1991 |
+
"description": "Output only. Immutable. Identifier. Resource name of the WorkloadUpdate. Format: organizations/{organization}/locations/{location}/workloads/{workload}/updates/{update}",
|
| 1992 |
+
"readOnly": true,
|
| 1993 |
+
"type": "string"
|
| 1994 |
+
},
|
| 1995 |
+
"state": {
|
| 1996 |
+
"description": "Output only. The state of the update.",
|
| 1997 |
+
"enum": [
|
| 1998 |
+
"STATE_UNSPECIFIED",
|
| 1999 |
+
"AVAILABLE",
|
| 2000 |
+
"APPLIED",
|
| 2001 |
+
"WITHDRAWN"
|
| 2002 |
+
],
|
| 2003 |
+
"enumDescriptions": [
|
| 2004 |
+
"Unspecified.",
|
| 2005 |
+
"The update is available to be applied.",
|
| 2006 |
+
"The update has been applied.",
|
| 2007 |
+
"The update has been withdrawn by the service."
|
| 2008 |
+
],
|
| 2009 |
+
"readOnly": true,
|
| 2010 |
+
"type": "string"
|
| 2011 |
+
},
|
| 2012 |
+
"updateTime": {
|
| 2013 |
+
"description": "The time the update was last updated.",
|
| 2014 |
+
"format": "google-datetime",
|
| 2015 |
+
"type": "string"
|
| 2016 |
+
}
|
| 2017 |
+
},
|
| 2018 |
+
"type": "object"
|
| 2019 |
+
},
|
| 2020 |
+
"GoogleCloudAssuredworkloadsV1beta1WorkloadWorkloadOptions": {
|
| 2021 |
+
"description": "Options to be set for the given created workload.",
|
| 2022 |
+
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadWorkloadOptions",
|
| 2023 |
+
"properties": {
|
| 2024 |
+
"kajEnrollmentType": {
|
| 2025 |
+
"description": "Optional. Specifies type of KAJ Enrollment if provided.",
|
| 2026 |
+
"enum": [
|
| 2027 |
+
"KAJ_ENROLLMENT_TYPE_UNSPECIFIED",
|
| 2028 |
+
"KEY_ACCESS_TRANSPARENCY_OFF"
|
| 2029 |
+
],
|
| 2030 |
+
"enumDescriptions": [
|
| 2031 |
+
"KAJ Enrollment type is unspecified",
|
| 2032 |
+
"KAT sets External, Hardware, and Software key feature logging only to TRUE. (no enforcement)"
|
| 2033 |
+
],
|
| 2034 |
+
"type": "string"
|
| 2035 |
+
}
|
| 2036 |
+
},
|
| 2037 |
+
"type": "object"
|
| 2038 |
+
},
|
| 2039 |
+
"GoogleLongrunningListOperationsResponse": {
|
| 2040 |
+
"description": "The response message for Operations.ListOperations.",
|
| 2041 |
+
"id": "GoogleLongrunningListOperationsResponse",
|
| 2042 |
+
"properties": {
|
| 2043 |
+
"nextPageToken": {
|
| 2044 |
+
"description": "The standard List next-page token.",
|
| 2045 |
+
"type": "string"
|
| 2046 |
+
},
|
| 2047 |
+
"operations": {
|
| 2048 |
+
"description": "A list of operations that matches the specified filter in the request.",
|
| 2049 |
+
"items": {
|
| 2050 |
+
"$ref": "GoogleLongrunningOperation"
|
| 2051 |
+
},
|
| 2052 |
+
"type": "array"
|
| 2053 |
+
}
|
| 2054 |
+
},
|
| 2055 |
+
"type": "object"
|
| 2056 |
+
},
|
| 2057 |
+
"GoogleLongrunningOperation": {
|
| 2058 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 2059 |
+
"id": "GoogleLongrunningOperation",
|
| 2060 |
+
"properties": {
|
| 2061 |
+
"done": {
|
| 2062 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 2063 |
+
"type": "boolean"
|
| 2064 |
+
},
|
| 2065 |
+
"error": {
|
| 2066 |
+
"$ref": "GoogleRpcStatus",
|
| 2067 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 2068 |
+
},
|
| 2069 |
+
"metadata": {
|
| 2070 |
+
"additionalProperties": {
|
| 2071 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 2072 |
+
"type": "any"
|
| 2073 |
+
},
|
| 2074 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 2075 |
+
"type": "object"
|
| 2076 |
+
},
|
| 2077 |
+
"name": {
|
| 2078 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 2079 |
+
"type": "string"
|
| 2080 |
+
},
|
| 2081 |
+
"response": {
|
| 2082 |
+
"additionalProperties": {
|
| 2083 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 2084 |
+
"type": "any"
|
| 2085 |
+
},
|
| 2086 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 2087 |
+
"type": "object"
|
| 2088 |
+
}
|
| 2089 |
+
},
|
| 2090 |
+
"type": "object"
|
| 2091 |
+
},
|
| 2092 |
+
"GoogleProtobufEmpty": {
|
| 2093 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 2094 |
+
"id": "GoogleProtobufEmpty",
|
| 2095 |
+
"properties": {},
|
| 2096 |
+
"type": "object"
|
| 2097 |
+
},
|
| 2098 |
+
"GoogleRpcStatus": {
|
| 2099 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 2100 |
+
"id": "GoogleRpcStatus",
|
| 2101 |
+
"properties": {
|
| 2102 |
+
"code": {
|
| 2103 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 2104 |
+
"format": "int32",
|
| 2105 |
+
"type": "integer"
|
| 2106 |
+
},
|
| 2107 |
+
"details": {
|
| 2108 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 2109 |
+
"items": {
|
| 2110 |
+
"additionalProperties": {
|
| 2111 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 2112 |
+
"type": "any"
|
| 2113 |
+
},
|
| 2114 |
+
"type": "object"
|
| 2115 |
+
},
|
| 2116 |
+
"type": "array"
|
| 2117 |
+
},
|
| 2118 |
+
"message": {
|
| 2119 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 2120 |
+
"type": "string"
|
| 2121 |
+
}
|
| 2122 |
+
},
|
| 2123 |
+
"type": "object"
|
| 2124 |
+
}
|
| 2125 |
+
},
|
| 2126 |
+
"servicePath": "",
|
| 2127 |
+
"title": "Assured Workloads API",
|
| 2128 |
+
"version": "v1beta1",
|
| 2129 |
+
"version_module": true
|
| 2130 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/baremetalsolution.v1alpha1.json
ADDED
|
@@ -0,0 +1,588 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://baremetalsolution.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.",
|
| 15 |
+
"discoveryVersion": "v1",
|
| 16 |
+
"documentationLink": "https://cloud.google.com/bare-metal",
|
| 17 |
+
"fullyEncodeReservedExpansion": true,
|
| 18 |
+
"icons": {
|
| 19 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 20 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 21 |
+
},
|
| 22 |
+
"id": "baremetalsolution:v1alpha1",
|
| 23 |
+
"kind": "discovery#restDescription",
|
| 24 |
+
"mtlsRootUrl": "https://baremetalsolution.mtls.googleapis.com/",
|
| 25 |
+
"name": "baremetalsolution",
|
| 26 |
+
"ownerDomain": "google.com",
|
| 27 |
+
"ownerName": "Google",
|
| 28 |
+
"parameters": {
|
| 29 |
+
"$.xgafv": {
|
| 30 |
+
"description": "V1 error format.",
|
| 31 |
+
"enum": [
|
| 32 |
+
"1",
|
| 33 |
+
"2"
|
| 34 |
+
],
|
| 35 |
+
"enumDescriptions": [
|
| 36 |
+
"v1 error format",
|
| 37 |
+
"v2 error format"
|
| 38 |
+
],
|
| 39 |
+
"location": "query",
|
| 40 |
+
"type": "string"
|
| 41 |
+
},
|
| 42 |
+
"access_token": {
|
| 43 |
+
"description": "OAuth access token.",
|
| 44 |
+
"location": "query",
|
| 45 |
+
"type": "string"
|
| 46 |
+
},
|
| 47 |
+
"alt": {
|
| 48 |
+
"default": "json",
|
| 49 |
+
"description": "Data format for response.",
|
| 50 |
+
"enum": [
|
| 51 |
+
"json",
|
| 52 |
+
"media",
|
| 53 |
+
"proto"
|
| 54 |
+
],
|
| 55 |
+
"enumDescriptions": [
|
| 56 |
+
"Responses with Content-Type of application/json",
|
| 57 |
+
"Media download with context-dependent Content-Type",
|
| 58 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 59 |
+
],
|
| 60 |
+
"location": "query",
|
| 61 |
+
"type": "string"
|
| 62 |
+
},
|
| 63 |
+
"callback": {
|
| 64 |
+
"description": "JSONP",
|
| 65 |
+
"location": "query",
|
| 66 |
+
"type": "string"
|
| 67 |
+
},
|
| 68 |
+
"fields": {
|
| 69 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 70 |
+
"location": "query",
|
| 71 |
+
"type": "string"
|
| 72 |
+
},
|
| 73 |
+
"key": {
|
| 74 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 75 |
+
"location": "query",
|
| 76 |
+
"type": "string"
|
| 77 |
+
},
|
| 78 |
+
"oauth_token": {
|
| 79 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 80 |
+
"location": "query",
|
| 81 |
+
"type": "string"
|
| 82 |
+
},
|
| 83 |
+
"prettyPrint": {
|
| 84 |
+
"default": "true",
|
| 85 |
+
"description": "Returns response with indentations and line breaks.",
|
| 86 |
+
"location": "query",
|
| 87 |
+
"type": "boolean"
|
| 88 |
+
},
|
| 89 |
+
"quotaUser": {
|
| 90 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 91 |
+
"location": "query",
|
| 92 |
+
"type": "string"
|
| 93 |
+
},
|
| 94 |
+
"uploadType": {
|
| 95 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 96 |
+
"location": "query",
|
| 97 |
+
"type": "string"
|
| 98 |
+
},
|
| 99 |
+
"upload_protocol": {
|
| 100 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 101 |
+
"location": "query",
|
| 102 |
+
"type": "string"
|
| 103 |
+
}
|
| 104 |
+
},
|
| 105 |
+
"protocol": "rest",
|
| 106 |
+
"resources": {
|
| 107 |
+
"projects": {
|
| 108 |
+
"resources": {
|
| 109 |
+
"locations": {
|
| 110 |
+
"methods": {
|
| 111 |
+
"submitProvisioningConfig": {
|
| 112 |
+
"description": "Submit a provisiong configuration for a given project.",
|
| 113 |
+
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:submitProvisioningConfig",
|
| 114 |
+
"httpMethod": "POST",
|
| 115 |
+
"id": "baremetalsolution.projects.locations.submitProvisioningConfig",
|
| 116 |
+
"parameterOrder": [
|
| 117 |
+
"project",
|
| 118 |
+
"location"
|
| 119 |
+
],
|
| 120 |
+
"parameters": {
|
| 121 |
+
"location": {
|
| 122 |
+
"description": "Required. The target location of the provisioning request.",
|
| 123 |
+
"location": "path",
|
| 124 |
+
"pattern": "^locations/[^/]+$",
|
| 125 |
+
"required": true,
|
| 126 |
+
"type": "string"
|
| 127 |
+
},
|
| 128 |
+
"project": {
|
| 129 |
+
"description": "Required. The target project of the provisioning request.",
|
| 130 |
+
"location": "path",
|
| 131 |
+
"pattern": "^projects/[^/]+$",
|
| 132 |
+
"required": true,
|
| 133 |
+
"type": "string"
|
| 134 |
+
}
|
| 135 |
+
},
|
| 136 |
+
"path": "v1alpha1/{+project}/{+location}:submitProvisioningConfig",
|
| 137 |
+
"request": {
|
| 138 |
+
"$ref": "SubmitProvisioningConfigRequest"
|
| 139 |
+
},
|
| 140 |
+
"response": {
|
| 141 |
+
"$ref": "ProvisioningConfig"
|
| 142 |
+
},
|
| 143 |
+
"scopes": [
|
| 144 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 145 |
+
]
|
| 146 |
+
}
|
| 147 |
+
}
|
| 148 |
+
},
|
| 149 |
+
"provisioningQuotas": {
|
| 150 |
+
"methods": {
|
| 151 |
+
"list": {
|
| 152 |
+
"description": "List the budget details to provision resources on a given project.",
|
| 153 |
+
"flatPath": "v1alpha1/projects/{projectsId}/provisioningQuotas",
|
| 154 |
+
"httpMethod": "GET",
|
| 155 |
+
"id": "baremetalsolution.projects.provisioningQuotas.list",
|
| 156 |
+
"parameterOrder": [
|
| 157 |
+
"parent"
|
| 158 |
+
],
|
| 159 |
+
"parameters": {
|
| 160 |
+
"pageSize": {
|
| 161 |
+
"description": "The maximum number of items to return.",
|
| 162 |
+
"format": "int32",
|
| 163 |
+
"location": "query",
|
| 164 |
+
"type": "integer"
|
| 165 |
+
},
|
| 166 |
+
"pageToken": {
|
| 167 |
+
"description": "The next_page_token value returned from a previous List request, if any.",
|
| 168 |
+
"location": "query",
|
| 169 |
+
"type": "string"
|
| 170 |
+
},
|
| 171 |
+
"parent": {
|
| 172 |
+
"description": "Required. The parent project containing the provisioning quotas.",
|
| 173 |
+
"location": "path",
|
| 174 |
+
"pattern": "^projects/[^/]+$",
|
| 175 |
+
"required": true,
|
| 176 |
+
"type": "string"
|
| 177 |
+
}
|
| 178 |
+
},
|
| 179 |
+
"path": "v1alpha1/{+parent}/provisioningQuotas",
|
| 180 |
+
"response": {
|
| 181 |
+
"$ref": "ListProvisioningQuotasResponse"
|
| 182 |
+
},
|
| 183 |
+
"scopes": [
|
| 184 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 185 |
+
]
|
| 186 |
+
}
|
| 187 |
+
}
|
| 188 |
+
}
|
| 189 |
+
}
|
| 190 |
+
}
|
| 191 |
+
},
|
| 192 |
+
"revision": "20220829",
|
| 193 |
+
"rootUrl": "https://baremetalsolution.googleapis.com/",
|
| 194 |
+
"schemas": {
|
| 195 |
+
"InstanceConfig": {
|
| 196 |
+
"description": "Configuration parameters for a new instance.",
|
| 197 |
+
"id": "InstanceConfig",
|
| 198 |
+
"properties": {
|
| 199 |
+
"clientNetwork": {
|
| 200 |
+
"$ref": "NetworkAddress",
|
| 201 |
+
"description": "Client network address."
|
| 202 |
+
},
|
| 203 |
+
"hyperthreading": {
|
| 204 |
+
"description": "Whether the instance should be provisioned with Hyperthreading enabled.",
|
| 205 |
+
"type": "boolean"
|
| 206 |
+
},
|
| 207 |
+
"id": {
|
| 208 |
+
"description": "A transient unique identifier to idenfity an instance within an ProvisioningConfig request.",
|
| 209 |
+
"type": "string"
|
| 210 |
+
},
|
| 211 |
+
"instanceType": {
|
| 212 |
+
"description": "Instance type.",
|
| 213 |
+
"type": "string"
|
| 214 |
+
},
|
| 215 |
+
"location": {
|
| 216 |
+
"description": "Location where to deploy the instance.",
|
| 217 |
+
"type": "string"
|
| 218 |
+
},
|
| 219 |
+
"osImage": {
|
| 220 |
+
"description": "OS image to initialize the instance.",
|
| 221 |
+
"type": "string"
|
| 222 |
+
},
|
| 223 |
+
"privateNetwork": {
|
| 224 |
+
"$ref": "NetworkAddress",
|
| 225 |
+
"description": "Private network address, if any."
|
| 226 |
+
},
|
| 227 |
+
"userNote": {
|
| 228 |
+
"description": "User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).",
|
| 229 |
+
"type": "string"
|
| 230 |
+
}
|
| 231 |
+
},
|
| 232 |
+
"type": "object"
|
| 233 |
+
},
|
| 234 |
+
"InstanceQuota": {
|
| 235 |
+
"description": "A resource budget.",
|
| 236 |
+
"id": "InstanceQuota",
|
| 237 |
+
"properties": {
|
| 238 |
+
"availableMachineCount": {
|
| 239 |
+
"description": "Number of machines than can be created for the given location and instance_type.",
|
| 240 |
+
"format": "int32",
|
| 241 |
+
"type": "integer"
|
| 242 |
+
},
|
| 243 |
+
"instanceType": {
|
| 244 |
+
"description": "Instance type.",
|
| 245 |
+
"type": "string"
|
| 246 |
+
},
|
| 247 |
+
"location": {
|
| 248 |
+
"description": "Location where the quota applies.",
|
| 249 |
+
"type": "string"
|
| 250 |
+
}
|
| 251 |
+
},
|
| 252 |
+
"type": "object"
|
| 253 |
+
},
|
| 254 |
+
"ListProvisioningQuotasResponse": {
|
| 255 |
+
"description": "Response for ListProvisioningQuotas.",
|
| 256 |
+
"id": "ListProvisioningQuotasResponse",
|
| 257 |
+
"properties": {
|
| 258 |
+
"nextPageToken": {
|
| 259 |
+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
|
| 260 |
+
"type": "string"
|
| 261 |
+
},
|
| 262 |
+
"provisioningQuotas": {
|
| 263 |
+
"description": "The provisioning quotas registered in this project.",
|
| 264 |
+
"items": {
|
| 265 |
+
"$ref": "ProvisioningQuota"
|
| 266 |
+
},
|
| 267 |
+
"type": "array"
|
| 268 |
+
}
|
| 269 |
+
},
|
| 270 |
+
"type": "object"
|
| 271 |
+
},
|
| 272 |
+
"LunRange": {
|
| 273 |
+
"description": "A LUN range.",
|
| 274 |
+
"id": "LunRange",
|
| 275 |
+
"properties": {
|
| 276 |
+
"quantity": {
|
| 277 |
+
"description": "Number of LUNs to create.",
|
| 278 |
+
"format": "int32",
|
| 279 |
+
"type": "integer"
|
| 280 |
+
},
|
| 281 |
+
"sizeGb": {
|
| 282 |
+
"description": "The requested size of each LUN, in GB.",
|
| 283 |
+
"format": "int32",
|
| 284 |
+
"type": "integer"
|
| 285 |
+
}
|
| 286 |
+
},
|
| 287 |
+
"type": "object"
|
| 288 |
+
},
|
| 289 |
+
"NetworkAddress": {
|
| 290 |
+
"description": "A network.",
|
| 291 |
+
"id": "NetworkAddress",
|
| 292 |
+
"properties": {
|
| 293 |
+
"address": {
|
| 294 |
+
"description": "IP address to be assigned to the server.",
|
| 295 |
+
"type": "string"
|
| 296 |
+
},
|
| 297 |
+
"existingNetworkId": {
|
| 298 |
+
"description": "Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.",
|
| 299 |
+
"type": "string"
|
| 300 |
+
},
|
| 301 |
+
"networkId": {
|
| 302 |
+
"description": "Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.",
|
| 303 |
+
"type": "string"
|
| 304 |
+
}
|
| 305 |
+
},
|
| 306 |
+
"type": "object"
|
| 307 |
+
},
|
| 308 |
+
"NetworkConfig": {
|
| 309 |
+
"description": "Configuration parameters for a new network.",
|
| 310 |
+
"id": "NetworkConfig",
|
| 311 |
+
"properties": {
|
| 312 |
+
"bandwidth": {
|
| 313 |
+
"description": "Interconnect bandwidth. Set only when type is CLIENT.",
|
| 314 |
+
"enum": [
|
| 315 |
+
"BANDWIDTH_UNSPECIFIED",
|
| 316 |
+
"BW_1_GBPS",
|
| 317 |
+
"BW_2_GBPS",
|
| 318 |
+
"BW_5_GBPS",
|
| 319 |
+
"BW_10_GBPS"
|
| 320 |
+
],
|
| 321 |
+
"enumDescriptions": [
|
| 322 |
+
"Unspecified value.",
|
| 323 |
+
"1 Gbps.",
|
| 324 |
+
"2 Gbps.",
|
| 325 |
+
"5 Gbps.",
|
| 326 |
+
"10 Gbps."
|
| 327 |
+
],
|
| 328 |
+
"type": "string"
|
| 329 |
+
},
|
| 330 |
+
"cidr": {
|
| 331 |
+
"description": "CIDR range of the network.",
|
| 332 |
+
"type": "string"
|
| 333 |
+
},
|
| 334 |
+
"id": {
|
| 335 |
+
"description": "A transient unique identifier to identify a volume within an ProvisioningConfig request.",
|
| 336 |
+
"type": "string"
|
| 337 |
+
},
|
| 338 |
+
"location": {
|
| 339 |
+
"description": "Location where to deploy the network.",
|
| 340 |
+
"type": "string"
|
| 341 |
+
},
|
| 342 |
+
"serviceCidr": {
|
| 343 |
+
"description": "Service CIDR, if any.",
|
| 344 |
+
"enum": [
|
| 345 |
+
"SERVICE_CIDR_UNSPECIFIED",
|
| 346 |
+
"DISABLED",
|
| 347 |
+
"HIGH_26",
|
| 348 |
+
"HIGH_27",
|
| 349 |
+
"HIGH_28"
|
| 350 |
+
],
|
| 351 |
+
"enumDescriptions": [
|
| 352 |
+
"Unspecified value.",
|
| 353 |
+
"Services are disabled for the given network.",
|
| 354 |
+
"Use the highest /26 block of the network to host services.",
|
| 355 |
+
"Use the highest /27 block of the network to host services.",
|
| 356 |
+
"Use the highest /28 block of the network to host services."
|
| 357 |
+
],
|
| 358 |
+
"type": "string"
|
| 359 |
+
},
|
| 360 |
+
"type": {
|
| 361 |
+
"description": "The type of this network.",
|
| 362 |
+
"enum": [
|
| 363 |
+
"TYPE_UNSPECIFIED",
|
| 364 |
+
"CLIENT",
|
| 365 |
+
"PRIVATE"
|
| 366 |
+
],
|
| 367 |
+
"enumDescriptions": [
|
| 368 |
+
"Unspecified value.",
|
| 369 |
+
"Client network, that is a network peered to a GCP VPC.",
|
| 370 |
+
"Private network, that is a network local to the BMS POD."
|
| 371 |
+
],
|
| 372 |
+
"type": "string"
|
| 373 |
+
},
|
| 374 |
+
"userNote": {
|
| 375 |
+
"description": "User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).",
|
| 376 |
+
"type": "string"
|
| 377 |
+
},
|
| 378 |
+
"vlanAttachments": {
|
| 379 |
+
"description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).",
|
| 380 |
+
"items": {
|
| 381 |
+
"$ref": "VlanAttachment"
|
| 382 |
+
},
|
| 383 |
+
"type": "array"
|
| 384 |
+
}
|
| 385 |
+
},
|
| 386 |
+
"type": "object"
|
| 387 |
+
},
|
| 388 |
+
"NfsExport": {
|
| 389 |
+
"description": "A NFS export entry.",
|
| 390 |
+
"id": "NfsExport",
|
| 391 |
+
"properties": {
|
| 392 |
+
"allowDev": {
|
| 393 |
+
"description": "Allow dev.",
|
| 394 |
+
"type": "boolean"
|
| 395 |
+
},
|
| 396 |
+
"allowSuid": {
|
| 397 |
+
"description": "Allow the setuid flag.",
|
| 398 |
+
"type": "boolean"
|
| 399 |
+
},
|
| 400 |
+
"cidr": {
|
| 401 |
+
"description": "A CIDR range.",
|
| 402 |
+
"type": "string"
|
| 403 |
+
},
|
| 404 |
+
"machineId": {
|
| 405 |
+
"description": "Either a single machine, identified by an ID, or a comma-separated list of machine IDs.",
|
| 406 |
+
"type": "string"
|
| 407 |
+
},
|
| 408 |
+
"networkId": {
|
| 409 |
+
"description": "Network to use to publish the export.",
|
| 410 |
+
"type": "string"
|
| 411 |
+
},
|
| 412 |
+
"noRootSquash": {
|
| 413 |
+
"description": "Disable root squashing.",
|
| 414 |
+
"type": "boolean"
|
| 415 |
+
},
|
| 416 |
+
"permissions": {
|
| 417 |
+
"description": "Export permissions.",
|
| 418 |
+
"enum": [
|
| 419 |
+
"PERMISSIONS_UNSPECIFIED",
|
| 420 |
+
"READ_ONLY",
|
| 421 |
+
"READ_WRITE"
|
| 422 |
+
],
|
| 423 |
+
"enumDescriptions": [
|
| 424 |
+
"Unspecified value.",
|
| 425 |
+
"Read-only permission.",
|
| 426 |
+
"Read-write permission."
|
| 427 |
+
],
|
| 428 |
+
"type": "string"
|
| 429 |
+
}
|
| 430 |
+
},
|
| 431 |
+
"type": "object"
|
| 432 |
+
},
|
| 433 |
+
"ProvisioningConfig": {
|
| 434 |
+
"description": "An provisioning configuration.",
|
| 435 |
+
"id": "ProvisioningConfig",
|
| 436 |
+
"properties": {
|
| 437 |
+
"instances": {
|
| 438 |
+
"description": "Instances to be created.",
|
| 439 |
+
"items": {
|
| 440 |
+
"$ref": "InstanceConfig"
|
| 441 |
+
},
|
| 442 |
+
"type": "array"
|
| 443 |
+
},
|
| 444 |
+
"networks": {
|
| 445 |
+
"description": "Networks to be created.",
|
| 446 |
+
"items": {
|
| 447 |
+
"$ref": "NetworkConfig"
|
| 448 |
+
},
|
| 449 |
+
"type": "array"
|
| 450 |
+
},
|
| 451 |
+
"ticketId": {
|
| 452 |
+
"description": "A reference to track the request.",
|
| 453 |
+
"type": "string"
|
| 454 |
+
},
|
| 455 |
+
"volumes": {
|
| 456 |
+
"description": "Volumes to be created.",
|
| 457 |
+
"items": {
|
| 458 |
+
"$ref": "VolumeConfig"
|
| 459 |
+
},
|
| 460 |
+
"type": "array"
|
| 461 |
+
}
|
| 462 |
+
},
|
| 463 |
+
"type": "object"
|
| 464 |
+
},
|
| 465 |
+
"ProvisioningQuota": {
|
| 466 |
+
"description": "A provisioning quota for a given project.",
|
| 467 |
+
"id": "ProvisioningQuota",
|
| 468 |
+
"properties": {
|
| 469 |
+
"instanceQuota": {
|
| 470 |
+
"$ref": "InstanceQuota",
|
| 471 |
+
"description": "Instance quota."
|
| 472 |
+
}
|
| 473 |
+
},
|
| 474 |
+
"type": "object"
|
| 475 |
+
},
|
| 476 |
+
"SubmitProvisioningConfigRequest": {
|
| 477 |
+
"description": "Request for SubmitProvisioningConfig.",
|
| 478 |
+
"id": "SubmitProvisioningConfigRequest",
|
| 479 |
+
"properties": {
|
| 480 |
+
"email": {
|
| 481 |
+
"description": "Optional. Email provided to send a confirmation with provisioning config to.",
|
| 482 |
+
"type": "string"
|
| 483 |
+
},
|
| 484 |
+
"provisioningConfig": {
|
| 485 |
+
"$ref": "ProvisioningConfig",
|
| 486 |
+
"description": "Required. The ProvisioningConfig to submit."
|
| 487 |
+
}
|
| 488 |
+
},
|
| 489 |
+
"type": "object"
|
| 490 |
+
},
|
| 491 |
+
"VlanAttachment": {
|
| 492 |
+
"description": "A GCP vlan attachment.",
|
| 493 |
+
"id": "VlanAttachment",
|
| 494 |
+
"properties": {
|
| 495 |
+
"id": {
|
| 496 |
+
"description": "Identifier of the VLAN attachment.",
|
| 497 |
+
"type": "string"
|
| 498 |
+
},
|
| 499 |
+
"pairingKey": {
|
| 500 |
+
"description": "Attachment pairing key.",
|
| 501 |
+
"type": "string"
|
| 502 |
+
}
|
| 503 |
+
},
|
| 504 |
+
"type": "object"
|
| 505 |
+
},
|
| 506 |
+
"VolumeConfig": {
|
| 507 |
+
"description": "Configuration parameters for a new volume.",
|
| 508 |
+
"id": "VolumeConfig",
|
| 509 |
+
"properties": {
|
| 510 |
+
"id": {
|
| 511 |
+
"description": "A transient unique identifier to identify a volume within an ProvisioningConfig request.",
|
| 512 |
+
"type": "string"
|
| 513 |
+
},
|
| 514 |
+
"location": {
|
| 515 |
+
"description": "Location where to deploy the volume.",
|
| 516 |
+
"type": "string"
|
| 517 |
+
},
|
| 518 |
+
"lunRanges": {
|
| 519 |
+
"description": "LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.",
|
| 520 |
+
"items": {
|
| 521 |
+
"$ref": "LunRange"
|
| 522 |
+
},
|
| 523 |
+
"type": "array"
|
| 524 |
+
},
|
| 525 |
+
"machineIds": {
|
| 526 |
+
"description": "Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.",
|
| 527 |
+
"items": {
|
| 528 |
+
"type": "string"
|
| 529 |
+
},
|
| 530 |
+
"type": "array"
|
| 531 |
+
},
|
| 532 |
+
"nfsExports": {
|
| 533 |
+
"description": "NFS exports. Set only when protocol is PROTOCOL_NFS.",
|
| 534 |
+
"items": {
|
| 535 |
+
"$ref": "NfsExport"
|
| 536 |
+
},
|
| 537 |
+
"type": "array"
|
| 538 |
+
},
|
| 539 |
+
"protocol": {
|
| 540 |
+
"description": "Volume protocol.",
|
| 541 |
+
"enum": [
|
| 542 |
+
"PROTOCOL_UNSPECIFIED",
|
| 543 |
+
"PROTOCOL_FC",
|
| 544 |
+
"PROTOCOL_NFS"
|
| 545 |
+
],
|
| 546 |
+
"enumDescriptions": [
|
| 547 |
+
"Unspecified value.",
|
| 548 |
+
"Fibre channel.",
|
| 549 |
+
"Network file system."
|
| 550 |
+
],
|
| 551 |
+
"type": "string"
|
| 552 |
+
},
|
| 553 |
+
"sizeGb": {
|
| 554 |
+
"description": "The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.",
|
| 555 |
+
"format": "int32",
|
| 556 |
+
"type": "integer"
|
| 557 |
+
},
|
| 558 |
+
"snapshotsEnabled": {
|
| 559 |
+
"description": "Whether snapshots should be enabled.",
|
| 560 |
+
"type": "boolean"
|
| 561 |
+
},
|
| 562 |
+
"type": {
|
| 563 |
+
"description": "The type of this Volume.",
|
| 564 |
+
"enum": [
|
| 565 |
+
"TYPE_UNSPECIFIED",
|
| 566 |
+
"FLASH",
|
| 567 |
+
"DISK"
|
| 568 |
+
],
|
| 569 |
+
"enumDescriptions": [
|
| 570 |
+
"The unspecified type.",
|
| 571 |
+
"This Volume is on flash.",
|
| 572 |
+
"This Volume is on disk."
|
| 573 |
+
],
|
| 574 |
+
"type": "string"
|
| 575 |
+
},
|
| 576 |
+
"userNote": {
|
| 577 |
+
"description": "User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).",
|
| 578 |
+
"type": "string"
|
| 579 |
+
}
|
| 580 |
+
},
|
| 581 |
+
"type": "object"
|
| 582 |
+
}
|
| 583 |
+
},
|
| 584 |
+
"servicePath": "",
|
| 585 |
+
"title": "Bare Metal Solution API",
|
| 586 |
+
"version": "v1alpha1",
|
| 587 |
+
"version_module": true
|
| 588 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json
ADDED
|
@@ -0,0 +1,715 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/bigquery": {
|
| 6 |
+
"description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 9 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://bigquerydatapolicy.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "BigQuery DataPolicy Service",
|
| 18 |
+
"description": "Allows users to manage BigQuery data policies.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "bigquerydatapolicy:v1",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://bigquerydatapolicy.mtls.googleapis.com/",
|
| 29 |
+
"name": "bigquerydatapolicy",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"parameters": {
|
| 33 |
+
"$.xgafv": {
|
| 34 |
+
"description": "V1 error format.",
|
| 35 |
+
"enum": [
|
| 36 |
+
"1",
|
| 37 |
+
"2"
|
| 38 |
+
],
|
| 39 |
+
"enumDescriptions": [
|
| 40 |
+
"v1 error format",
|
| 41 |
+
"v2 error format"
|
| 42 |
+
],
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"access_token": {
|
| 47 |
+
"description": "OAuth access token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"alt": {
|
| 52 |
+
"default": "json",
|
| 53 |
+
"description": "Data format for response.",
|
| 54 |
+
"enum": [
|
| 55 |
+
"json",
|
| 56 |
+
"media",
|
| 57 |
+
"proto"
|
| 58 |
+
],
|
| 59 |
+
"enumDescriptions": [
|
| 60 |
+
"Responses with Content-Type of application/json",
|
| 61 |
+
"Media download with context-dependent Content-Type",
|
| 62 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 63 |
+
],
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"callback": {
|
| 68 |
+
"description": "JSONP",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
},
|
| 72 |
+
"fields": {
|
| 73 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 74 |
+
"location": "query",
|
| 75 |
+
"type": "string"
|
| 76 |
+
},
|
| 77 |
+
"key": {
|
| 78 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 79 |
+
"location": "query",
|
| 80 |
+
"type": "string"
|
| 81 |
+
},
|
| 82 |
+
"oauth_token": {
|
| 83 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 84 |
+
"location": "query",
|
| 85 |
+
"type": "string"
|
| 86 |
+
},
|
| 87 |
+
"prettyPrint": {
|
| 88 |
+
"default": "true",
|
| 89 |
+
"description": "Returns response with indentations and line breaks.",
|
| 90 |
+
"location": "query",
|
| 91 |
+
"type": "boolean"
|
| 92 |
+
},
|
| 93 |
+
"quotaUser": {
|
| 94 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 95 |
+
"location": "query",
|
| 96 |
+
"type": "string"
|
| 97 |
+
},
|
| 98 |
+
"uploadType": {
|
| 99 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 100 |
+
"location": "query",
|
| 101 |
+
"type": "string"
|
| 102 |
+
},
|
| 103 |
+
"upload_protocol": {
|
| 104 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 105 |
+
"location": "query",
|
| 106 |
+
"type": "string"
|
| 107 |
+
}
|
| 108 |
+
},
|
| 109 |
+
"protocol": "rest",
|
| 110 |
+
"resources": {
|
| 111 |
+
"projects": {
|
| 112 |
+
"resources": {
|
| 113 |
+
"locations": {
|
| 114 |
+
"resources": {
|
| 115 |
+
"dataPolicies": {
|
| 116 |
+
"methods": {
|
| 117 |
+
"create": {
|
| 118 |
+
"description": "Creates a new data policy under a project with the given `dataPolicyId` (used as the display name), policy tag, and data policy type.",
|
| 119 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies",
|
| 120 |
+
"httpMethod": "POST",
|
| 121 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.create",
|
| 122 |
+
"parameterOrder": [
|
| 123 |
+
"parent"
|
| 124 |
+
],
|
| 125 |
+
"parameters": {
|
| 126 |
+
"parent": {
|
| 127 |
+
"description": "Required. Resource name of the project that the data policy will belong to. The format is `projects/{project_number}/locations/{location_id}`.",
|
| 128 |
+
"location": "path",
|
| 129 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 130 |
+
"required": true,
|
| 131 |
+
"type": "string"
|
| 132 |
+
}
|
| 133 |
+
},
|
| 134 |
+
"path": "v1/{+parent}/dataPolicies",
|
| 135 |
+
"request": {
|
| 136 |
+
"$ref": "DataPolicy"
|
| 137 |
+
},
|
| 138 |
+
"response": {
|
| 139 |
+
"$ref": "DataPolicy"
|
| 140 |
+
},
|
| 141 |
+
"scopes": [
|
| 142 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 143 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 144 |
+
]
|
| 145 |
+
},
|
| 146 |
+
"delete": {
|
| 147 |
+
"description": "Deletes the data policy specified by its resource name.",
|
| 148 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}",
|
| 149 |
+
"httpMethod": "DELETE",
|
| 150 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.delete",
|
| 151 |
+
"parameterOrder": [
|
| 152 |
+
"name"
|
| 153 |
+
],
|
| 154 |
+
"parameters": {
|
| 155 |
+
"force": {
|
| 156 |
+
"description": "Optional. If true, the data policy will be deleted even when it is referenced by one or more table columns.",
|
| 157 |
+
"location": "query",
|
| 158 |
+
"type": "boolean"
|
| 159 |
+
},
|
| 160 |
+
"name": {
|
| 161 |
+
"description": "Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.",
|
| 162 |
+
"location": "path",
|
| 163 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 164 |
+
"required": true,
|
| 165 |
+
"type": "string"
|
| 166 |
+
}
|
| 167 |
+
},
|
| 168 |
+
"path": "v1/{+name}",
|
| 169 |
+
"response": {
|
| 170 |
+
"$ref": "Empty"
|
| 171 |
+
},
|
| 172 |
+
"scopes": [
|
| 173 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 174 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 175 |
+
]
|
| 176 |
+
},
|
| 177 |
+
"get": {
|
| 178 |
+
"description": "Gets the data policy specified by its resource name.",
|
| 179 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}",
|
| 180 |
+
"httpMethod": "GET",
|
| 181 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.get",
|
| 182 |
+
"parameterOrder": [
|
| 183 |
+
"name"
|
| 184 |
+
],
|
| 185 |
+
"parameters": {
|
| 186 |
+
"name": {
|
| 187 |
+
"description": "Required. Resource name of the requested data policy. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.",
|
| 188 |
+
"location": "path",
|
| 189 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 190 |
+
"required": true,
|
| 191 |
+
"type": "string"
|
| 192 |
+
}
|
| 193 |
+
},
|
| 194 |
+
"path": "v1/{+name}",
|
| 195 |
+
"response": {
|
| 196 |
+
"$ref": "DataPolicy"
|
| 197 |
+
},
|
| 198 |
+
"scopes": [
|
| 199 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 200 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 201 |
+
]
|
| 202 |
+
},
|
| 203 |
+
"getIamPolicy": {
|
| 204 |
+
"description": "Gets the IAM policy for the specified data policy.",
|
| 205 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:getIamPolicy",
|
| 206 |
+
"httpMethod": "POST",
|
| 207 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.getIamPolicy",
|
| 208 |
+
"parameterOrder": [
|
| 209 |
+
"resource"
|
| 210 |
+
],
|
| 211 |
+
"parameters": {
|
| 212 |
+
"resource": {
|
| 213 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 214 |
+
"location": "path",
|
| 215 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 216 |
+
"required": true,
|
| 217 |
+
"type": "string"
|
| 218 |
+
}
|
| 219 |
+
},
|
| 220 |
+
"path": "v1/{+resource}:getIamPolicy",
|
| 221 |
+
"request": {
|
| 222 |
+
"$ref": "GetIamPolicyRequest"
|
| 223 |
+
},
|
| 224 |
+
"response": {
|
| 225 |
+
"$ref": "Policy"
|
| 226 |
+
},
|
| 227 |
+
"scopes": [
|
| 228 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 229 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 230 |
+
]
|
| 231 |
+
},
|
| 232 |
+
"list": {
|
| 233 |
+
"description": "List all of the data policies in the specified parent project.",
|
| 234 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies",
|
| 235 |
+
"httpMethod": "GET",
|
| 236 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.list",
|
| 237 |
+
"parameterOrder": [
|
| 238 |
+
"parent"
|
| 239 |
+
],
|
| 240 |
+
"parameters": {
|
| 241 |
+
"filter": {
|
| 242 |
+
"description": "Filters the data policies by policy tags that they are associated with. Currently filter only supports \"policy_tag\" based filtering and OR based predicates. Sample filter can be \"policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3\". You may also use wildcard such as \"policy_tag: projects/1/locations/us/taxonomies/2*\". Please note that OR predicates cannot be used with wildcard filters.",
|
| 243 |
+
"location": "query",
|
| 244 |
+
"type": "string"
|
| 245 |
+
},
|
| 246 |
+
"pageSize": {
|
| 247 |
+
"description": "The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.",
|
| 248 |
+
"format": "int32",
|
| 249 |
+
"location": "query",
|
| 250 |
+
"type": "integer"
|
| 251 |
+
},
|
| 252 |
+
"pageToken": {
|
| 253 |
+
"description": "The `nextPageToken` value returned from a previous list request, if any. If not set, defaults to an empty string.",
|
| 254 |
+
"location": "query",
|
| 255 |
+
"type": "string"
|
| 256 |
+
},
|
| 257 |
+
"parent": {
|
| 258 |
+
"description": "Required. Resource name of the project for which to list data policies. Format is `projects/{project_number}/locations/{location_id}`.",
|
| 259 |
+
"location": "path",
|
| 260 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 261 |
+
"required": true,
|
| 262 |
+
"type": "string"
|
| 263 |
+
}
|
| 264 |
+
},
|
| 265 |
+
"path": "v1/{+parent}/dataPolicies",
|
| 266 |
+
"response": {
|
| 267 |
+
"$ref": "ListDataPoliciesResponse"
|
| 268 |
+
},
|
| 269 |
+
"scopes": [
|
| 270 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 271 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 272 |
+
]
|
| 273 |
+
},
|
| 274 |
+
"patch": {
|
| 275 |
+
"description": "Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.",
|
| 276 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}",
|
| 277 |
+
"httpMethod": "PATCH",
|
| 278 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.patch",
|
| 279 |
+
"parameterOrder": [
|
| 280 |
+
"name"
|
| 281 |
+
],
|
| 282 |
+
"parameters": {
|
| 283 |
+
"allowMissing": {
|
| 284 |
+
"description": "Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.",
|
| 285 |
+
"location": "query",
|
| 286 |
+
"type": "boolean"
|
| 287 |
+
},
|
| 288 |
+
"name": {
|
| 289 |
+
"description": "Output only. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.",
|
| 290 |
+
"location": "path",
|
| 291 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 292 |
+
"required": true,
|
| 293 |
+
"type": "string"
|
| 294 |
+
},
|
| 295 |
+
"updateMask": {
|
| 296 |
+
"description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the `name` and `dataPolicyId` fields are not allowed.",
|
| 297 |
+
"format": "google-fieldmask",
|
| 298 |
+
"location": "query",
|
| 299 |
+
"type": "string"
|
| 300 |
+
}
|
| 301 |
+
},
|
| 302 |
+
"path": "v1/{+name}",
|
| 303 |
+
"request": {
|
| 304 |
+
"$ref": "DataPolicy"
|
| 305 |
+
},
|
| 306 |
+
"response": {
|
| 307 |
+
"$ref": "DataPolicy"
|
| 308 |
+
},
|
| 309 |
+
"scopes": [
|
| 310 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 311 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 312 |
+
]
|
| 313 |
+
},
|
| 314 |
+
"rename": {
|
| 315 |
+
"description": "Renames the id (display name) of the specified data policy.",
|
| 316 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:rename",
|
| 317 |
+
"httpMethod": "POST",
|
| 318 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.rename",
|
| 319 |
+
"parameterOrder": [
|
| 320 |
+
"name"
|
| 321 |
+
],
|
| 322 |
+
"parameters": {
|
| 323 |
+
"name": {
|
| 324 |
+
"description": "Required. Resource name of the data policy to rename. The format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`",
|
| 325 |
+
"location": "path",
|
| 326 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 327 |
+
"required": true,
|
| 328 |
+
"type": "string"
|
| 329 |
+
}
|
| 330 |
+
},
|
| 331 |
+
"path": "v1/{+name}:rename",
|
| 332 |
+
"request": {
|
| 333 |
+
"$ref": "RenameDataPolicyRequest"
|
| 334 |
+
},
|
| 335 |
+
"response": {
|
| 336 |
+
"$ref": "DataPolicy"
|
| 337 |
+
},
|
| 338 |
+
"scopes": [
|
| 339 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 340 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 341 |
+
]
|
| 342 |
+
},
|
| 343 |
+
"setIamPolicy": {
|
| 344 |
+
"description": "Sets the IAM policy for the specified data policy.",
|
| 345 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:setIamPolicy",
|
| 346 |
+
"httpMethod": "POST",
|
| 347 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.setIamPolicy",
|
| 348 |
+
"parameterOrder": [
|
| 349 |
+
"resource"
|
| 350 |
+
],
|
| 351 |
+
"parameters": {
|
| 352 |
+
"resource": {
|
| 353 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 354 |
+
"location": "path",
|
| 355 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 356 |
+
"required": true,
|
| 357 |
+
"type": "string"
|
| 358 |
+
}
|
| 359 |
+
},
|
| 360 |
+
"path": "v1/{+resource}:setIamPolicy",
|
| 361 |
+
"request": {
|
| 362 |
+
"$ref": "SetIamPolicyRequest"
|
| 363 |
+
},
|
| 364 |
+
"response": {
|
| 365 |
+
"$ref": "Policy"
|
| 366 |
+
},
|
| 367 |
+
"scopes": [
|
| 368 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 369 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 370 |
+
]
|
| 371 |
+
},
|
| 372 |
+
"testIamPermissions": {
|
| 373 |
+
"description": "Returns the caller's permission on the specified data policy resource.",
|
| 374 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:testIamPermissions",
|
| 375 |
+
"httpMethod": "POST",
|
| 376 |
+
"id": "bigquerydatapolicy.projects.locations.dataPolicies.testIamPermissions",
|
| 377 |
+
"parameterOrder": [
|
| 378 |
+
"resource"
|
| 379 |
+
],
|
| 380 |
+
"parameters": {
|
| 381 |
+
"resource": {
|
| 382 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 383 |
+
"location": "path",
|
| 384 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$",
|
| 385 |
+
"required": true,
|
| 386 |
+
"type": "string"
|
| 387 |
+
}
|
| 388 |
+
},
|
| 389 |
+
"path": "v1/{+resource}:testIamPermissions",
|
| 390 |
+
"request": {
|
| 391 |
+
"$ref": "TestIamPermissionsRequest"
|
| 392 |
+
},
|
| 393 |
+
"response": {
|
| 394 |
+
"$ref": "TestIamPermissionsResponse"
|
| 395 |
+
},
|
| 396 |
+
"scopes": [
|
| 397 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 398 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 399 |
+
]
|
| 400 |
+
}
|
| 401 |
+
}
|
| 402 |
+
}
|
| 403 |
+
}
|
| 404 |
+
}
|
| 405 |
+
}
|
| 406 |
+
}
|
| 407 |
+
},
|
| 408 |
+
"revision": "20240806",
|
| 409 |
+
"rootUrl": "https://bigquerydatapolicy.googleapis.com/",
|
| 410 |
+
"schemas": {
|
| 411 |
+
"AuditConfig": {
|
| 412 |
+
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
|
| 413 |
+
"id": "AuditConfig",
|
| 414 |
+
"properties": {
|
| 415 |
+
"auditLogConfigs": {
|
| 416 |
+
"description": "The configuration for logging of each type of permission.",
|
| 417 |
+
"items": {
|
| 418 |
+
"$ref": "AuditLogConfig"
|
| 419 |
+
},
|
| 420 |
+
"type": "array"
|
| 421 |
+
},
|
| 422 |
+
"service": {
|
| 423 |
+
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
|
| 424 |
+
"type": "string"
|
| 425 |
+
}
|
| 426 |
+
},
|
| 427 |
+
"type": "object"
|
| 428 |
+
},
|
| 429 |
+
"AuditLogConfig": {
|
| 430 |
+
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
|
| 431 |
+
"id": "AuditLogConfig",
|
| 432 |
+
"properties": {
|
| 433 |
+
"exemptedMembers": {
|
| 434 |
+
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
|
| 435 |
+
"items": {
|
| 436 |
+
"type": "string"
|
| 437 |
+
},
|
| 438 |
+
"type": "array"
|
| 439 |
+
},
|
| 440 |
+
"logType": {
|
| 441 |
+
"description": "The log type that this config enables.",
|
| 442 |
+
"enum": [
|
| 443 |
+
"LOG_TYPE_UNSPECIFIED",
|
| 444 |
+
"ADMIN_READ",
|
| 445 |
+
"DATA_WRITE",
|
| 446 |
+
"DATA_READ"
|
| 447 |
+
],
|
| 448 |
+
"enumDescriptions": [
|
| 449 |
+
"Default case. Should never be this.",
|
| 450 |
+
"Admin reads. Example: CloudIAM getIamPolicy",
|
| 451 |
+
"Data writes. Example: CloudSQL Users create",
|
| 452 |
+
"Data reads. Example: CloudSQL Users list"
|
| 453 |
+
],
|
| 454 |
+
"type": "string"
|
| 455 |
+
}
|
| 456 |
+
},
|
| 457 |
+
"type": "object"
|
| 458 |
+
},
|
| 459 |
+
"Binding": {
|
| 460 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 461 |
+
"id": "Binding",
|
| 462 |
+
"properties": {
|
| 463 |
+
"condition": {
|
| 464 |
+
"$ref": "Expr",
|
| 465 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 466 |
+
},
|
| 467 |
+
"members": {
|
| 468 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 469 |
+
"items": {
|
| 470 |
+
"type": "string"
|
| 471 |
+
},
|
| 472 |
+
"type": "array"
|
| 473 |
+
},
|
| 474 |
+
"role": {
|
| 475 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 476 |
+
"type": "string"
|
| 477 |
+
}
|
| 478 |
+
},
|
| 479 |
+
"type": "object"
|
| 480 |
+
},
|
| 481 |
+
"DataMaskingPolicy": {
|
| 482 |
+
"description": "The data masking policy that is used to specify data masking rule.",
|
| 483 |
+
"id": "DataMaskingPolicy",
|
| 484 |
+
"properties": {
|
| 485 |
+
"predefinedExpression": {
|
| 486 |
+
"description": "A predefined masking expression.",
|
| 487 |
+
"enum": [
|
| 488 |
+
"PREDEFINED_EXPRESSION_UNSPECIFIED",
|
| 489 |
+
"SHA256",
|
| 490 |
+
"ALWAYS_NULL",
|
| 491 |
+
"DEFAULT_MASKING_VALUE",
|
| 492 |
+
"LAST_FOUR_CHARACTERS",
|
| 493 |
+
"FIRST_FOUR_CHARACTERS",
|
| 494 |
+
"EMAIL_MASK",
|
| 495 |
+
"DATE_YEAR_MASK"
|
| 496 |
+
],
|
| 497 |
+
"enumDescriptions": [
|
| 498 |
+
"Default, unspecified predefined expression. No masking will take place since no expression is specified.",
|
| 499 |
+
"Masking expression to replace data with SHA-256 hash.",
|
| 500 |
+
"Masking expression to replace data with NULLs.",
|
| 501 |
+
"Masking expression to replace data with their default masking values. The default masking values for each type listed as below: * STRING: \"\" * BYTES: b'' * INTEGER: 0 * FLOAT: 0.0 * NUMERIC: 0 * BOOLEAN: FALSE * TIMESTAMP: 1970-01-01 00:00:00 UTC * DATE: 1970-01-01 * TIME: 00:00:00 * DATETIME: 1970-01-01T00:00:00 * GEOGRAPHY: POINT(0 0) * BIGNUMERIC: 0 * ARRAY: [] * STRUCT: NOT_APPLICABLE * JSON: NULL",
|
| 502 |
+
"Masking expression shows the last four characters of text. The masking behavior is as follows: * If text length > 4 characters: Replace text with XXXXX, append last four characters of original text. * If text length <= 4 characters: Apply SHA-256 hash.",
|
| 503 |
+
"Masking expression shows the first four characters of text. The masking behavior is as follows: * If text length > 4 characters: Replace text with XXXXX, prepend first four characters of original text. * If text length <= 4 characters: Apply SHA-256 hash.",
|
| 504 |
+
"Masking expression for email addresses. The masking behavior is as follows: * Syntax-valid email address: Replace username with XXXXX. For example, cloudysanfrancisco@gmail.com becomes XXXXX@gmail.com. * Syntax-invalid email address: Apply SHA-256 hash. For more information, see Email mask.",
|
| 505 |
+
"Masking expression to only show the *year* of `Date`, `DateTime` and `TimeStamp`. For example, with the year 2076: * DATE : 2076-01-01 * DATETIME : 2076-01-01T00:00:00 * TIMESTAMP : 2076-01-01 00:00:00 UTC Truncation occurs according to the UTC time zone. To change this, adjust the default time zone using the `time_zone` system variable. For more information, see the System variables reference."
|
| 506 |
+
],
|
| 507 |
+
"type": "string"
|
| 508 |
+
},
|
| 509 |
+
"routine": {
|
| 510 |
+
"description": "The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.",
|
| 511 |
+
"type": "string"
|
| 512 |
+
}
|
| 513 |
+
},
|
| 514 |
+
"type": "object"
|
| 515 |
+
},
|
| 516 |
+
"DataPolicy": {
|
| 517 |
+
"description": "Represents the label-policy binding.",
|
| 518 |
+
"id": "DataPolicy",
|
| 519 |
+
"properties": {
|
| 520 |
+
"dataMaskingPolicy": {
|
| 521 |
+
"$ref": "DataMaskingPolicy",
|
| 522 |
+
"description": "The data masking policy that specifies the data masking rule to use."
|
| 523 |
+
},
|
| 524 |
+
"dataPolicyId": {
|
| 525 |
+
"description": "User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.",
|
| 526 |
+
"type": "string"
|
| 527 |
+
},
|
| 528 |
+
"dataPolicyType": {
|
| 529 |
+
"description": "Type of data policy.",
|
| 530 |
+
"enum": [
|
| 531 |
+
"DATA_POLICY_TYPE_UNSPECIFIED",
|
| 532 |
+
"COLUMN_LEVEL_SECURITY_POLICY",
|
| 533 |
+
"DATA_MASKING_POLICY"
|
| 534 |
+
],
|
| 535 |
+
"enumDescriptions": [
|
| 536 |
+
"Default value for the data policy type. This should not be used.",
|
| 537 |
+
"Used to create a data policy for column-level security, without data masking.",
|
| 538 |
+
"Used to create a data policy for data masking."
|
| 539 |
+
],
|
| 540 |
+
"type": "string"
|
| 541 |
+
},
|
| 542 |
+
"name": {
|
| 543 |
+
"description": "Output only. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.",
|
| 544 |
+
"readOnly": true,
|
| 545 |
+
"type": "string"
|
| 546 |
+
},
|
| 547 |
+
"policyTag": {
|
| 548 |
+
"description": "Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`.",
|
| 549 |
+
"type": "string"
|
| 550 |
+
}
|
| 551 |
+
},
|
| 552 |
+
"type": "object"
|
| 553 |
+
},
|
| 554 |
+
"Empty": {
|
| 555 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 556 |
+
"id": "Empty",
|
| 557 |
+
"properties": {},
|
| 558 |
+
"type": "object"
|
| 559 |
+
},
|
| 560 |
+
"Expr": {
|
| 561 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 562 |
+
"id": "Expr",
|
| 563 |
+
"properties": {
|
| 564 |
+
"description": {
|
| 565 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 566 |
+
"type": "string"
|
| 567 |
+
},
|
| 568 |
+
"expression": {
|
| 569 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 570 |
+
"type": "string"
|
| 571 |
+
},
|
| 572 |
+
"location": {
|
| 573 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 574 |
+
"type": "string"
|
| 575 |
+
},
|
| 576 |
+
"title": {
|
| 577 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 578 |
+
"type": "string"
|
| 579 |
+
}
|
| 580 |
+
},
|
| 581 |
+
"type": "object"
|
| 582 |
+
},
|
| 583 |
+
"GetIamPolicyRequest": {
|
| 584 |
+
"description": "Request message for `GetIamPolicy` method.",
|
| 585 |
+
"id": "GetIamPolicyRequest",
|
| 586 |
+
"properties": {
|
| 587 |
+
"options": {
|
| 588 |
+
"$ref": "GetPolicyOptions",
|
| 589 |
+
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."
|
| 590 |
+
}
|
| 591 |
+
},
|
| 592 |
+
"type": "object"
|
| 593 |
+
},
|
| 594 |
+
"GetPolicyOptions": {
|
| 595 |
+
"description": "Encapsulates settings provided to GetIamPolicy.",
|
| 596 |
+
"id": "GetPolicyOptions",
|
| 597 |
+
"properties": {
|
| 598 |
+
"requestedPolicyVersion": {
|
| 599 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 600 |
+
"format": "int32",
|
| 601 |
+
"type": "integer"
|
| 602 |
+
}
|
| 603 |
+
},
|
| 604 |
+
"type": "object"
|
| 605 |
+
},
|
| 606 |
+
"ListDataPoliciesResponse": {
|
| 607 |
+
"description": "Response message for the ListDataPolicies method.",
|
| 608 |
+
"id": "ListDataPoliciesResponse",
|
| 609 |
+
"properties": {
|
| 610 |
+
"dataPolicies": {
|
| 611 |
+
"description": "Data policies that belong to the requested project.",
|
| 612 |
+
"items": {
|
| 613 |
+
"$ref": "DataPolicy"
|
| 614 |
+
},
|
| 615 |
+
"type": "array"
|
| 616 |
+
},
|
| 617 |
+
"nextPageToken": {
|
| 618 |
+
"description": "Token used to retrieve the next page of results, or empty if there are no more results.",
|
| 619 |
+
"type": "string"
|
| 620 |
+
}
|
| 621 |
+
},
|
| 622 |
+
"type": "object"
|
| 623 |
+
},
|
| 624 |
+
"Policy": {
|
| 625 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 626 |
+
"id": "Policy",
|
| 627 |
+
"properties": {
|
| 628 |
+
"auditConfigs": {
|
| 629 |
+
"description": "Specifies cloud audit logging configuration for this policy.",
|
| 630 |
+
"items": {
|
| 631 |
+
"$ref": "AuditConfig"
|
| 632 |
+
},
|
| 633 |
+
"type": "array"
|
| 634 |
+
},
|
| 635 |
+
"bindings": {
|
| 636 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 637 |
+
"items": {
|
| 638 |
+
"$ref": "Binding"
|
| 639 |
+
},
|
| 640 |
+
"type": "array"
|
| 641 |
+
},
|
| 642 |
+
"etag": {
|
| 643 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 644 |
+
"format": "byte",
|
| 645 |
+
"type": "string"
|
| 646 |
+
},
|
| 647 |
+
"version": {
|
| 648 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 649 |
+
"format": "int32",
|
| 650 |
+
"type": "integer"
|
| 651 |
+
}
|
| 652 |
+
},
|
| 653 |
+
"type": "object"
|
| 654 |
+
},
|
| 655 |
+
"RenameDataPolicyRequest": {
|
| 656 |
+
"description": "Request message for the RenameDataPolicy method.",
|
| 657 |
+
"id": "RenameDataPolicyRequest",
|
| 658 |
+
"properties": {
|
| 659 |
+
"newDataPolicyId": {
|
| 660 |
+
"description": "Required. The new data policy id.",
|
| 661 |
+
"type": "string"
|
| 662 |
+
}
|
| 663 |
+
},
|
| 664 |
+
"type": "object"
|
| 665 |
+
},
|
| 666 |
+
"SetIamPolicyRequest": {
|
| 667 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 668 |
+
"id": "SetIamPolicyRequest",
|
| 669 |
+
"properties": {
|
| 670 |
+
"policy": {
|
| 671 |
+
"$ref": "Policy",
|
| 672 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 673 |
+
},
|
| 674 |
+
"updateMask": {
|
| 675 |
+
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
|
| 676 |
+
"format": "google-fieldmask",
|
| 677 |
+
"type": "string"
|
| 678 |
+
}
|
| 679 |
+
},
|
| 680 |
+
"type": "object"
|
| 681 |
+
},
|
| 682 |
+
"TestIamPermissionsRequest": {
|
| 683 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 684 |
+
"id": "TestIamPermissionsRequest",
|
| 685 |
+
"properties": {
|
| 686 |
+
"permissions": {
|
| 687 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 688 |
+
"items": {
|
| 689 |
+
"type": "string"
|
| 690 |
+
},
|
| 691 |
+
"type": "array"
|
| 692 |
+
}
|
| 693 |
+
},
|
| 694 |
+
"type": "object"
|
| 695 |
+
},
|
| 696 |
+
"TestIamPermissionsResponse": {
|
| 697 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 698 |
+
"id": "TestIamPermissionsResponse",
|
| 699 |
+
"properties": {
|
| 700 |
+
"permissions": {
|
| 701 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 702 |
+
"items": {
|
| 703 |
+
"type": "string"
|
| 704 |
+
},
|
| 705 |
+
"type": "array"
|
| 706 |
+
}
|
| 707 |
+
},
|
| 708 |
+
"type": "object"
|
| 709 |
+
}
|
| 710 |
+
},
|
| 711 |
+
"servicePath": "",
|
| 712 |
+
"title": "BigQuery Data Policy API",
|
| 713 |
+
"version": "v1",
|
| 714 |
+
"version_module": true
|
| 715 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/bigqueryreservation.v1alpha2.json
ADDED
|
@@ -0,0 +1,904 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"description": "A service to modify your BigQuery flat-rate reservations.",
|
| 3 |
+
"documentationLink": "https://cloud.google.com/bigquery/",
|
| 4 |
+
"parameters": {
|
| 5 |
+
"$.xgafv": {
|
| 6 |
+
"enum": [
|
| 7 |
+
"1",
|
| 8 |
+
"2"
|
| 9 |
+
],
|
| 10 |
+
"location": "query",
|
| 11 |
+
"enumDescriptions": [
|
| 12 |
+
"v1 error format",
|
| 13 |
+
"v2 error format"
|
| 14 |
+
],
|
| 15 |
+
"description": "V1 error format.",
|
| 16 |
+
"type": "string"
|
| 17 |
+
},
|
| 18 |
+
"fields": {
|
| 19 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 20 |
+
"type": "string",
|
| 21 |
+
"location": "query"
|
| 22 |
+
},
|
| 23 |
+
"callback": {
|
| 24 |
+
"location": "query",
|
| 25 |
+
"type": "string",
|
| 26 |
+
"description": "JSONP"
|
| 27 |
+
},
|
| 28 |
+
"quotaUser": {
|
| 29 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 30 |
+
"type": "string",
|
| 31 |
+
"location": "query"
|
| 32 |
+
},
|
| 33 |
+
"oauth_token": {
|
| 34 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 35 |
+
"location": "query",
|
| 36 |
+
"type": "string"
|
| 37 |
+
},
|
| 38 |
+
"uploadType": {
|
| 39 |
+
"location": "query",
|
| 40 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"key": {
|
| 44 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 45 |
+
"type": "string",
|
| 46 |
+
"location": "query"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"location": "query",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"default": "json",
|
| 57 |
+
"enumDescriptions": [
|
| 58 |
+
"Responses with Content-Type of application/json",
|
| 59 |
+
"Media download with context-dependent Content-Type",
|
| 60 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 61 |
+
],
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"upload_protocol": {
|
| 65 |
+
"location": "query",
|
| 66 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"access_token": {
|
| 70 |
+
"description": "OAuth access token.",
|
| 71 |
+
"type": "string",
|
| 72 |
+
"location": "query"
|
| 73 |
+
},
|
| 74 |
+
"prettyPrint": {
|
| 75 |
+
"default": "true",
|
| 76 |
+
"description": "Returns response with indentations and line breaks.",
|
| 77 |
+
"type": "boolean",
|
| 78 |
+
"location": "query"
|
| 79 |
+
}
|
| 80 |
+
},
|
| 81 |
+
"ownerName": "Google",
|
| 82 |
+
"batchPath": "batch",
|
| 83 |
+
"revision": "20200801",
|
| 84 |
+
"title": "BigQuery Reservation API",
|
| 85 |
+
"schemas": {
|
| 86 |
+
"ListSlotPoolsResponse": {
|
| 87 |
+
"description": "The response for ReservationService.ListSlotPools.",
|
| 88 |
+
"type": "object",
|
| 89 |
+
"id": "ListSlotPoolsResponse",
|
| 90 |
+
"properties": {
|
| 91 |
+
"nextPageToken": {
|
| 92 |
+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"slotPools": {
|
| 96 |
+
"items": {
|
| 97 |
+
"$ref": "SlotPool"
|
| 98 |
+
},
|
| 99 |
+
"type": "array",
|
| 100 |
+
"description": "List of slot pools visible to the user."
|
| 101 |
+
}
|
| 102 |
+
}
|
| 103 |
+
},
|
| 104 |
+
"ReservationGrant": {
|
| 105 |
+
"id": "ReservationGrant",
|
| 106 |
+
"type": "object",
|
| 107 |
+
"description": "A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation.",
|
| 108 |
+
"properties": {
|
| 109 |
+
"grantee": {
|
| 110 |
+
"description": "The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.",
|
| 111 |
+
"type": "string"
|
| 112 |
+
},
|
| 113 |
+
"name": {
|
| 114 |
+
"type": "string",
|
| 115 |
+
"description": "Output only. Name of the resource. E.g.: projects/myproject/locations/eu/reservationGrants/123."
|
| 116 |
+
},
|
| 117 |
+
"state": {
|
| 118 |
+
"enum": [
|
| 119 |
+
"STATE_UNSPECIFIED",
|
| 120 |
+
"PENDING",
|
| 121 |
+
"ACTIVE"
|
| 122 |
+
],
|
| 123 |
+
"enumDescriptions": [
|
| 124 |
+
"Invalid state value.",
|
| 125 |
+
"Queries from grantee will be executed as on-demand, if related ReservationGrant is pending.",
|
| 126 |
+
"ReservationGrant is ready."
|
| 127 |
+
],
|
| 128 |
+
"description": "Output only. State of the ReservationGrant.",
|
| 129 |
+
"type": "string",
|
| 130 |
+
"readOnly": true
|
| 131 |
+
},
|
| 132 |
+
"reservation": {
|
| 133 |
+
"description": "Resource name of the reservation. E.g., projects/myproject/locations/eu/reservations/my_reservation. This reservation must be in the same location as the grant. This reservation should belong to the same parent project.",
|
| 134 |
+
"type": "string"
|
| 135 |
+
},
|
| 136 |
+
"jobType": {
|
| 137 |
+
"type": "string",
|
| 138 |
+
"description": "Which type of jobs will use the reservation.",
|
| 139 |
+
"enum": [
|
| 140 |
+
"JOB_TYPE_UNSPECIFIED",
|
| 141 |
+
"PIPELINE",
|
| 142 |
+
"QUERY"
|
| 143 |
+
],
|
| 144 |
+
"enumDescriptions": [
|
| 145 |
+
"Invalid type. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
|
| 146 |
+
"Pipeline (load/export) jobs from the project will use the reservation.",
|
| 147 |
+
"Query jobs from the project will use the reservation."
|
| 148 |
+
]
|
| 149 |
+
}
|
| 150 |
+
}
|
| 151 |
+
},
|
| 152 |
+
"Operation": {
|
| 153 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 154 |
+
"id": "Operation",
|
| 155 |
+
"type": "object",
|
| 156 |
+
"properties": {
|
| 157 |
+
"response": {
|
| 158 |
+
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 159 |
+
"type": "object",
|
| 160 |
+
"additionalProperties": {
|
| 161 |
+
"type": "any",
|
| 162 |
+
"description": "Properties of the object. Contains field @type with type URL."
|
| 163 |
+
}
|
| 164 |
+
},
|
| 165 |
+
"done": {
|
| 166 |
+
"type": "boolean",
|
| 167 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."
|
| 168 |
+
},
|
| 169 |
+
"error": {
|
| 170 |
+
"$ref": "Status",
|
| 171 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 172 |
+
},
|
| 173 |
+
"metadata": {
|
| 174 |
+
"type": "object",
|
| 175 |
+
"additionalProperties": {
|
| 176 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 177 |
+
"type": "any"
|
| 178 |
+
},
|
| 179 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."
|
| 180 |
+
},
|
| 181 |
+
"name": {
|
| 182 |
+
"type": "string",
|
| 183 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."
|
| 184 |
+
}
|
| 185 |
+
}
|
| 186 |
+
},
|
| 187 |
+
"Status": {
|
| 188 |
+
"type": "object",
|
| 189 |
+
"properties": {
|
| 190 |
+
"message": {
|
| 191 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 192 |
+
"type": "string"
|
| 193 |
+
},
|
| 194 |
+
"code": {
|
| 195 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 196 |
+
"format": "int32",
|
| 197 |
+
"type": "integer"
|
| 198 |
+
},
|
| 199 |
+
"details": {
|
| 200 |
+
"type": "array",
|
| 201 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 202 |
+
"items": {
|
| 203 |
+
"additionalProperties": {
|
| 204 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 205 |
+
"type": "any"
|
| 206 |
+
},
|
| 207 |
+
"type": "object"
|
| 208 |
+
}
|
| 209 |
+
}
|
| 210 |
+
},
|
| 211 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 212 |
+
"id": "Status"
|
| 213 |
+
},
|
| 214 |
+
"ListReservationsResponse": {
|
| 215 |
+
"description": "The response for ReservationService.ListReservations.",
|
| 216 |
+
"properties": {
|
| 217 |
+
"nextPageToken": {
|
| 218 |
+
"type": "string",
|
| 219 |
+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
|
| 220 |
+
},
|
| 221 |
+
"reservations": {
|
| 222 |
+
"type": "array",
|
| 223 |
+
"items": {
|
| 224 |
+
"$ref": "Reservation"
|
| 225 |
+
},
|
| 226 |
+
"description": "List of reservations visible to the user."
|
| 227 |
+
}
|
| 228 |
+
},
|
| 229 |
+
"type": "object",
|
| 230 |
+
"id": "ListReservationsResponse"
|
| 231 |
+
},
|
| 232 |
+
"Reservation": {
|
| 233 |
+
"id": "Reservation",
|
| 234 |
+
"description": "A reservation is a mechanism used to guarantee slots to users.",
|
| 235 |
+
"type": "object",
|
| 236 |
+
"properties": {
|
| 237 |
+
"name": {
|
| 238 |
+
"description": "The resource name of the reservation, e.g., \"projects/*/locations/*/reservations/dev/team/product\". Reservation names (e.g., \"dev/team/product\") exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.",
|
| 239 |
+
"type": "string"
|
| 240 |
+
},
|
| 241 |
+
"useParentReservation": {
|
| 242 |
+
"description": "If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.",
|
| 243 |
+
"type": "boolean"
|
| 244 |
+
},
|
| 245 |
+
"slotCapacity": {
|
| 246 |
+
"format": "int64",
|
| 247 |
+
"type": "string",
|
| 248 |
+
"description": "Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`."
|
| 249 |
+
}
|
| 250 |
+
}
|
| 251 |
+
},
|
| 252 |
+
"SlotPool": {
|
| 253 |
+
"type": "object",
|
| 254 |
+
"id": "SlotPool",
|
| 255 |
+
"properties": {
|
| 256 |
+
"state": {
|
| 257 |
+
"type": "string",
|
| 258 |
+
"enumDescriptions": [
|
| 259 |
+
"Invalid state value.",
|
| 260 |
+
"Slot pool is pending provisioning. Pending slot pool does not contribute to the parent's slot_capacity.",
|
| 261 |
+
"Once slots are provisioned, slot pool becomes active. slot_count is added to the parent's slot_capacity.",
|
| 262 |
+
"Slot pool is failed to be activated by the backend."
|
| 263 |
+
],
|
| 264 |
+
"description": "Output only.",
|
| 265 |
+
"enum": [
|
| 266 |
+
"STATE_UNSPECIFIED",
|
| 267 |
+
"PENDING",
|
| 268 |
+
"ACTIVE",
|
| 269 |
+
"FAILED"
|
| 270 |
+
]
|
| 271 |
+
},
|
| 272 |
+
"plan": {
|
| 273 |
+
"description": "Slot pool commitment plan.",
|
| 274 |
+
"type": "string",
|
| 275 |
+
"enum": [
|
| 276 |
+
"COMMITMENT_PLAN_UNSPECIFIED",
|
| 277 |
+
"FLEX",
|
| 278 |
+
"TRIAL",
|
| 279 |
+
"MONTHLY",
|
| 280 |
+
"ANNUAL"
|
| 281 |
+
],
|
| 282 |
+
"enumDescriptions": [
|
| 283 |
+
"Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
|
| 284 |
+
"Slot pool can be removed at any point, even after becoming ACTIVE.",
|
| 285 |
+
"Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the renewal_plan. Default renewal_plan for Trial commitment is Flex so that it can be deleted right after committed period ends.",
|
| 286 |
+
"Slot pool cannot be removed for 30 days after becoming ACTIVE.",
|
| 287 |
+
"Slot pool cannot be removed for 365 days after becoming ACTIVE. Note: annual commitments are automatically downgraded to monthly after 365 days."
|
| 288 |
+
]
|
| 289 |
+
},
|
| 290 |
+
"name": {
|
| 291 |
+
"type": "string",
|
| 292 |
+
"description": "Output only. The resource name of the slot pool, e.g., projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123"
|
| 293 |
+
},
|
| 294 |
+
"slotCount": {
|
| 295 |
+
"format": "int64",
|
| 296 |
+
"description": "Number of slots in this pool.",
|
| 297 |
+
"type": "string"
|
| 298 |
+
},
|
| 299 |
+
"failureStatus": {
|
| 300 |
+
"description": "Output only. For FAILED slot pool, provides the reason of failure.",
|
| 301 |
+
"readOnly": true,
|
| 302 |
+
"$ref": "Status"
|
| 303 |
+
},
|
| 304 |
+
"commitmentEndTime": {
|
| 305 |
+
"description": "Output only. The end of the commitment period. Slot pool cannot be removed before commitment_end_time. It is applicable only for ACTIVE slot pools and is computed as a combination of the plan and the time when the slot pool became ACTIVE.",
|
| 306 |
+
"type": "string",
|
| 307 |
+
"format": "google-datetime"
|
| 308 |
+
}
|
| 309 |
+
},
|
| 310 |
+
"description": "Slot pool is a way to purchase slots with some minimum committed period of usage. Slot pool is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. Annual commitments will automatically be downgraded to monthly after the commitment ends. A slot pool resource exists as a child resource of a top-level reservation. Sum of all the ACTIVE pools slot_count is always equal to the reservation slot_capacity."
|
| 311 |
+
},
|
| 312 |
+
"CreateSlotPoolMetadata": {
|
| 313 |
+
"id": "CreateSlotPoolMetadata",
|
| 314 |
+
"properties": {
|
| 315 |
+
"slotPool": {
|
| 316 |
+
"description": "Resource name of the slot pool that is being created. E.g., projects/myproject/locations/us-central1/reservations/foo/slotPools/123",
|
| 317 |
+
"type": "string"
|
| 318 |
+
}
|
| 319 |
+
},
|
| 320 |
+
"type": "object",
|
| 321 |
+
"description": "The metadata for operation returned from ReservationService.CreateSlotPool."
|
| 322 |
+
},
|
| 323 |
+
"SearchReservationGrantsResponse": {
|
| 324 |
+
"type": "object",
|
| 325 |
+
"id": "SearchReservationGrantsResponse",
|
| 326 |
+
"properties": {
|
| 327 |
+
"nextPageToken": {
|
| 328 |
+
"type": "string",
|
| 329 |
+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
|
| 330 |
+
},
|
| 331 |
+
"reservationGrants": {
|
| 332 |
+
"description": "List of reservation grants visible to the user.",
|
| 333 |
+
"items": {
|
| 334 |
+
"$ref": "ReservationGrant"
|
| 335 |
+
},
|
| 336 |
+
"type": "array"
|
| 337 |
+
}
|
| 338 |
+
},
|
| 339 |
+
"description": "The response for ReservationService.SearchReservationGrants."
|
| 340 |
+
},
|
| 341 |
+
"Empty": {
|
| 342 |
+
"properties": {},
|
| 343 |
+
"type": "object",
|
| 344 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
|
| 345 |
+
"id": "Empty"
|
| 346 |
+
},
|
| 347 |
+
"ListReservationGrantsResponse": {
|
| 348 |
+
"type": "object",
|
| 349 |
+
"properties": {
|
| 350 |
+
"nextPageToken": {
|
| 351 |
+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
|
| 352 |
+
"type": "string"
|
| 353 |
+
},
|
| 354 |
+
"reservationGrants": {
|
| 355 |
+
"type": "array",
|
| 356 |
+
"description": "List of reservation grants visible to the user.",
|
| 357 |
+
"items": {
|
| 358 |
+
"$ref": "ReservationGrant"
|
| 359 |
+
}
|
| 360 |
+
}
|
| 361 |
+
},
|
| 362 |
+
"id": "ListReservationGrantsResponse",
|
| 363 |
+
"description": "The response for ReservationService.ListReservationGrants."
|
| 364 |
+
}
|
| 365 |
+
},
|
| 366 |
+
"kind": "discovery#restDescription",
|
| 367 |
+
"canonicalName": "BigQuery Reservation",
|
| 368 |
+
"auth": {
|
| 369 |
+
"oauth2": {
|
| 370 |
+
"scopes": {
|
| 371 |
+
"https://www.googleapis.com/auth/bigquery": {
|
| 372 |
+
"description": "View and manage your data in Google BigQuery"
|
| 373 |
+
},
|
| 374 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 375 |
+
"description": "View and manage your data across Google Cloud Platform services"
|
| 376 |
+
}
|
| 377 |
+
}
|
| 378 |
+
}
|
| 379 |
+
},
|
| 380 |
+
"protocol": "rest",
|
| 381 |
+
"version_module": true,
|
| 382 |
+
"version": "v1alpha2",
|
| 383 |
+
"resources": {
|
| 384 |
+
"projects": {
|
| 385 |
+
"resources": {
|
| 386 |
+
"locations": {
|
| 387 |
+
"methods": {
|
| 388 |
+
"searchReservationGrants": {
|
| 389 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}:SearchReservationGrants",
|
| 390 |
+
"parameters": {
|
| 391 |
+
"pageSize": {
|
| 392 |
+
"description": "The maximum number of items to return.",
|
| 393 |
+
"type": "integer",
|
| 394 |
+
"location": "query",
|
| 395 |
+
"format": "int32"
|
| 396 |
+
},
|
| 397 |
+
"parent": {
|
| 398 |
+
"location": "path",
|
| 399 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 400 |
+
"description": "The parent resource name (containing project and location), which owns the grants. e.g.: \"projects/myproject/locations/us-central1\".",
|
| 401 |
+
"required": true,
|
| 402 |
+
"type": "string"
|
| 403 |
+
},
|
| 404 |
+
"pageToken": {
|
| 405 |
+
"location": "query",
|
| 406 |
+
"description": "The next_page_token value returned from a previous List request, if any.",
|
| 407 |
+
"type": "string"
|
| 408 |
+
},
|
| 409 |
+
"query": {
|
| 410 |
+
"location": "query",
|
| 411 |
+
"description": "Please specify resource name as grantee in the query. e.g., \"grantee=projects/myproject\" \"grantee=folders/123\" \"grantee=organizations/456\"",
|
| 412 |
+
"type": "string"
|
| 413 |
+
}
|
| 414 |
+
},
|
| 415 |
+
"id": "bigqueryreservation.projects.locations.searchReservationGrants",
|
| 416 |
+
"path": "v1alpha2/{+parent}:SearchReservationGrants",
|
| 417 |
+
"scopes": [
|
| 418 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 419 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 420 |
+
],
|
| 421 |
+
"description": "Look up grants for a specified resource for a particular region. If the request is about a project: 1) Grants created on the project will be returned if they exist. 2) Otherwise grants created on the closest ancestor will be returned. 3) Grants for different JobTypes will all be returned. Same logic applies if the request is about a folder. If the request is about an organization, then grants created on the organization will be returned (organization doesn't have ancestors). Comparing to ListReservationGrants, there are two behavior differences: 1) permission on the grantee will be verified in this API. 2) Hierarchy lookup (project-\u003efolder-\u003eorganization) happens in this API.",
|
| 422 |
+
"parameterOrder": [
|
| 423 |
+
"parent"
|
| 424 |
+
],
|
| 425 |
+
"response": {
|
| 426 |
+
"$ref": "SearchReservationGrantsResponse"
|
| 427 |
+
},
|
| 428 |
+
"httpMethod": "GET"
|
| 429 |
+
}
|
| 430 |
+
},
|
| 431 |
+
"resources": {
|
| 432 |
+
"reservations": {
|
| 433 |
+
"methods": {
|
| 434 |
+
"createReservation": {
|
| 435 |
+
"parameterOrder": [
|
| 436 |
+
"parent"
|
| 437 |
+
],
|
| 438 |
+
"id": "bigqueryreservation.projects.locations.reservations.createReservation",
|
| 439 |
+
"httpMethod": "POST",
|
| 440 |
+
"description": "Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.",
|
| 441 |
+
"request": {
|
| 442 |
+
"$ref": "Reservation"
|
| 443 |
+
},
|
| 444 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}",
|
| 445 |
+
"path": "v1alpha2/{+parent}",
|
| 446 |
+
"response": {
|
| 447 |
+
"$ref": "Reservation"
|
| 448 |
+
},
|
| 449 |
+
"parameters": {
|
| 450 |
+
"parent": {
|
| 451 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
| 452 |
+
"type": "string",
|
| 453 |
+
"description": "Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent",
|
| 454 |
+
"required": true,
|
| 455 |
+
"location": "path"
|
| 456 |
+
},
|
| 457 |
+
"reservationId": {
|
| 458 |
+
"type": "string",
|
| 459 |
+
"location": "query",
|
| 460 |
+
"description": "The reservation ID relative to the parent, e.g., \"dev\". This field must only contain alphanumeric characters."
|
| 461 |
+
}
|
| 462 |
+
},
|
| 463 |
+
"scopes": [
|
| 464 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 465 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 466 |
+
]
|
| 467 |
+
},
|
| 468 |
+
"create": {
|
| 469 |
+
"httpMethod": "POST",
|
| 470 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations",
|
| 471 |
+
"scopes": [
|
| 472 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 473 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 474 |
+
],
|
| 475 |
+
"response": {
|
| 476 |
+
"$ref": "Reservation"
|
| 477 |
+
},
|
| 478 |
+
"request": {
|
| 479 |
+
"$ref": "Reservation"
|
| 480 |
+
},
|
| 481 |
+
"parameterOrder": [
|
| 482 |
+
"parent"
|
| 483 |
+
],
|
| 484 |
+
"path": "v1alpha2/{+parent}/reservations",
|
| 485 |
+
"id": "bigqueryreservation.projects.locations.reservations.create",
|
| 486 |
+
"description": "Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.",
|
| 487 |
+
"parameters": {
|
| 488 |
+
"reservationId": {
|
| 489 |
+
"description": "The reservation ID relative to the parent, e.g., \"dev\". This field must only contain alphanumeric characters.",
|
| 490 |
+
"location": "query",
|
| 491 |
+
"type": "string"
|
| 492 |
+
},
|
| 493 |
+
"parent": {
|
| 494 |
+
"type": "string",
|
| 495 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 496 |
+
"description": "Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent",
|
| 497 |
+
"required": true,
|
| 498 |
+
"location": "path"
|
| 499 |
+
}
|
| 500 |
+
}
|
| 501 |
+
},
|
| 502 |
+
"delete": {
|
| 503 |
+
"response": {
|
| 504 |
+
"$ref": "Empty"
|
| 505 |
+
},
|
| 506 |
+
"parameterOrder": [
|
| 507 |
+
"name"
|
| 508 |
+
],
|
| 509 |
+
"path": "v1alpha2/{+name}",
|
| 510 |
+
"parameters": {
|
| 511 |
+
"name": {
|
| 512 |
+
"location": "path",
|
| 513 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
| 514 |
+
"type": "string",
|
| 515 |
+
"required": true,
|
| 516 |
+
"description": "Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation"
|
| 517 |
+
},
|
| 518 |
+
"force": {
|
| 519 |
+
"type": "boolean",
|
| 520 |
+
"location": "query",
|
| 521 |
+
"description": "If true, deletes all the child reservations of the given reservation. Otherwise, attempting to delete a reservation that has child reservations will fail with error code `google.rpc.Code.FAILED_PRECONDITION`."
|
| 522 |
+
}
|
| 523 |
+
},
|
| 524 |
+
"httpMethod": "DELETE",
|
| 525 |
+
"scopes": [
|
| 526 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 527 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 528 |
+
],
|
| 529 |
+
"id": "bigqueryreservation.projects.locations.reservations.delete",
|
| 530 |
+
"description": "Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases: 1. When reservation has child reservations. This check can be bypassed by setting DeleteReservationRequest.force flag to true. 2. When top-level reservation with slot pools is being deleted.",
|
| 531 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}"
|
| 532 |
+
},
|
| 533 |
+
"patch": {
|
| 534 |
+
"request": {
|
| 535 |
+
"$ref": "Reservation"
|
| 536 |
+
},
|
| 537 |
+
"parameterOrder": [
|
| 538 |
+
"name"
|
| 539 |
+
],
|
| 540 |
+
"id": "bigqueryreservation.projects.locations.reservations.patch",
|
| 541 |
+
"path": "v1alpha2/{+name}",
|
| 542 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/{reservationsId1}",
|
| 543 |
+
"httpMethod": "PATCH",
|
| 544 |
+
"scopes": [
|
| 545 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 546 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 547 |
+
],
|
| 548 |
+
"parameters": {
|
| 549 |
+
"updateMask": {
|
| 550 |
+
"location": "query",
|
| 551 |
+
"format": "google-fieldmask",
|
| 552 |
+
"description": "Standard field mask for the set of fields to be updated.",
|
| 553 |
+
"type": "string"
|
| 554 |
+
},
|
| 555 |
+
"name": {
|
| 556 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/.*$",
|
| 557 |
+
"type": "string",
|
| 558 |
+
"location": "path",
|
| 559 |
+
"description": "The resource name of the reservation, e.g., \"projects/*/locations/*/reservations/dev/team/product\". Reservation names (e.g., \"dev/team/product\") exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.",
|
| 560 |
+
"required": true
|
| 561 |
+
}
|
| 562 |
+
},
|
| 563 |
+
"response": {
|
| 564 |
+
"$ref": "Reservation"
|
| 565 |
+
},
|
| 566 |
+
"description": "Updates an existing reservation resource. Applicable only for child reservations."
|
| 567 |
+
},
|
| 568 |
+
"list": {
|
| 569 |
+
"path": "v1alpha2/{+parent}/reservations",
|
| 570 |
+
"response": {
|
| 571 |
+
"$ref": "ListReservationsResponse"
|
| 572 |
+
},
|
| 573 |
+
"parameters": {
|
| 574 |
+
"parent": {
|
| 575 |
+
"description": "The parent resource name containing project and location, e.g.: \"projects/myproject/locations/us-central1\"",
|
| 576 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 577 |
+
"required": true,
|
| 578 |
+
"location": "path",
|
| 579 |
+
"type": "string"
|
| 580 |
+
},
|
| 581 |
+
"filter": {
|
| 582 |
+
"type": "string",
|
| 583 |
+
"description": "Can be used to filter out reservations based on names, capacity, etc, e.g.: filter=\"reservation.slot_capacity \u003e 200\" filter=\"reservation.name = \\\"*dev/*\\\"\" Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters).",
|
| 584 |
+
"location": "query"
|
| 585 |
+
},
|
| 586 |
+
"pageToken": {
|
| 587 |
+
"type": "string",
|
| 588 |
+
"location": "query",
|
| 589 |
+
"description": "The next_page_token value returned from a previous List request, if any."
|
| 590 |
+
},
|
| 591 |
+
"pageSize": {
|
| 592 |
+
"location": "query",
|
| 593 |
+
"type": "integer",
|
| 594 |
+
"format": "int32",
|
| 595 |
+
"description": "The maximum number of items to return."
|
| 596 |
+
}
|
| 597 |
+
},
|
| 598 |
+
"parameterOrder": [
|
| 599 |
+
"parent"
|
| 600 |
+
],
|
| 601 |
+
"description": "Lists all the reservations for the project in the specified location.",
|
| 602 |
+
"id": "bigqueryreservation.projects.locations.reservations.list",
|
| 603 |
+
"scopes": [
|
| 604 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 605 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 606 |
+
],
|
| 607 |
+
"httpMethod": "GET",
|
| 608 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations"
|
| 609 |
+
},
|
| 610 |
+
"get": {
|
| 611 |
+
"scopes": [
|
| 612 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 613 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 614 |
+
],
|
| 615 |
+
"id": "bigqueryreservation.projects.locations.reservations.get",
|
| 616 |
+
"path": "v1alpha2/{+name}",
|
| 617 |
+
"parameterOrder": [
|
| 618 |
+
"name"
|
| 619 |
+
],
|
| 620 |
+
"parameters": {
|
| 621 |
+
"name": {
|
| 622 |
+
"type": "string",
|
| 623 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
| 624 |
+
"description": "Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/path/to/reserv",
|
| 625 |
+
"required": true,
|
| 626 |
+
"location": "path"
|
| 627 |
+
}
|
| 628 |
+
},
|
| 629 |
+
"description": "Returns information about the reservation.",
|
| 630 |
+
"httpMethod": "GET",
|
| 631 |
+
"response": {
|
| 632 |
+
"$ref": "Reservation"
|
| 633 |
+
},
|
| 634 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}"
|
| 635 |
+
}
|
| 636 |
+
},
|
| 637 |
+
"resources": {
|
| 638 |
+
"slotPools": {
|
| 639 |
+
"methods": {
|
| 640 |
+
"get": {
|
| 641 |
+
"path": "v1alpha2/{+name}",
|
| 642 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools/{slotPoolsId}",
|
| 643 |
+
"scopes": [
|
| 644 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 645 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 646 |
+
],
|
| 647 |
+
"response": {
|
| 648 |
+
"$ref": "SlotPool"
|
| 649 |
+
},
|
| 650 |
+
"parameters": {
|
| 651 |
+
"name": {
|
| 652 |
+
"location": "path",
|
| 653 |
+
"required": true,
|
| 654 |
+
"type": "string",
|
| 655 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/slotPools/[^/]+$",
|
| 656 |
+
"description": "Resource name of the slot pool to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123"
|
| 657 |
+
}
|
| 658 |
+
},
|
| 659 |
+
"id": "bigqueryreservation.projects.locations.reservations.slotPools.get",
|
| 660 |
+
"httpMethod": "GET",
|
| 661 |
+
"description": "Returns information about the slot pool.",
|
| 662 |
+
"parameterOrder": [
|
| 663 |
+
"name"
|
| 664 |
+
]
|
| 665 |
+
},
|
| 666 |
+
"list": {
|
| 667 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools",
|
| 668 |
+
"parameters": {
|
| 669 |
+
"pageToken": {
|
| 670 |
+
"location": "query",
|
| 671 |
+
"type": "string",
|
| 672 |
+
"description": "The next_page_token value returned from a previous List request, if any."
|
| 673 |
+
},
|
| 674 |
+
"parent": {
|
| 675 |
+
"required": true,
|
| 676 |
+
"location": "path",
|
| 677 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$",
|
| 678 |
+
"description": "Resource name of the parent reservation. Only top-level reservations can have slot pools. E.g., projects/myproject/locations/us-central1/reservations/my_reservation",
|
| 679 |
+
"type": "string"
|
| 680 |
+
},
|
| 681 |
+
"pageSize": {
|
| 682 |
+
"type": "integer",
|
| 683 |
+
"format": "int32",
|
| 684 |
+
"description": "The maximum number of items to return.",
|
| 685 |
+
"location": "query"
|
| 686 |
+
}
|
| 687 |
+
},
|
| 688 |
+
"description": "Lists all the slot pools for the reservation.",
|
| 689 |
+
"scopes": [
|
| 690 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 691 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 692 |
+
],
|
| 693 |
+
"path": "v1alpha2/{+parent}/slotPools",
|
| 694 |
+
"id": "bigqueryreservation.projects.locations.reservations.slotPools.list",
|
| 695 |
+
"parameterOrder": [
|
| 696 |
+
"parent"
|
| 697 |
+
],
|
| 698 |
+
"httpMethod": "GET",
|
| 699 |
+
"response": {
|
| 700 |
+
"$ref": "ListSlotPoolsResponse"
|
| 701 |
+
}
|
| 702 |
+
},
|
| 703 |
+
"delete": {
|
| 704 |
+
"httpMethod": "DELETE",
|
| 705 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools/{slotPoolsId}",
|
| 706 |
+
"path": "v1alpha2/{+name}",
|
| 707 |
+
"description": "Deletes a slot pool. Attempting to delete slot pool before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.",
|
| 708 |
+
"scopes": [
|
| 709 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 710 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 711 |
+
],
|
| 712 |
+
"id": "bigqueryreservation.projects.locations.reservations.slotPools.delete",
|
| 713 |
+
"response": {
|
| 714 |
+
"$ref": "Empty"
|
| 715 |
+
},
|
| 716 |
+
"parameterOrder": [
|
| 717 |
+
"name"
|
| 718 |
+
],
|
| 719 |
+
"parameters": {
|
| 720 |
+
"name": {
|
| 721 |
+
"required": true,
|
| 722 |
+
"description": "Resource name of the slot pool to delete. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123",
|
| 723 |
+
"type": "string",
|
| 724 |
+
"location": "path",
|
| 725 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/slotPools/[^/]+$"
|
| 726 |
+
}
|
| 727 |
+
}
|
| 728 |
+
}
|
| 729 |
+
}
|
| 730 |
+
}
|
| 731 |
+
}
|
| 732 |
+
},
|
| 733 |
+
"operations": {
|
| 734 |
+
"methods": {
|
| 735 |
+
"cancel": {
|
| 736 |
+
"parameters": {
|
| 737 |
+
"name": {
|
| 738 |
+
"type": "string",
|
| 739 |
+
"required": true,
|
| 740 |
+
"location": "path",
|
| 741 |
+
"description": "The name of the operation resource to be cancelled.",
|
| 742 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
|
| 743 |
+
}
|
| 744 |
+
},
|
| 745 |
+
"id": "bigqueryreservation.projects.locations.operations.cancel",
|
| 746 |
+
"response": {
|
| 747 |
+
"$ref": "Empty"
|
| 748 |
+
},
|
| 749 |
+
"httpMethod": "POST",
|
| 750 |
+
"parameterOrder": [
|
| 751 |
+
"name"
|
| 752 |
+
],
|
| 753 |
+
"scopes": [
|
| 754 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 755 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 756 |
+
],
|
| 757 |
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 758 |
+
"path": "v1alpha2/{+name}:cancel",
|
| 759 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel"
|
| 760 |
+
},
|
| 761 |
+
"get": {
|
| 762 |
+
"id": "bigqueryreservation.projects.locations.operations.get",
|
| 763 |
+
"response": {
|
| 764 |
+
"$ref": "Operation"
|
| 765 |
+
},
|
| 766 |
+
"path": "v1alpha2/{+name}",
|
| 767 |
+
"scopes": [
|
| 768 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 769 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 770 |
+
],
|
| 771 |
+
"parameters": {
|
| 772 |
+
"name": {
|
| 773 |
+
"description": "The name of the operation resource.",
|
| 774 |
+
"location": "path",
|
| 775 |
+
"required": true,
|
| 776 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 777 |
+
"type": "string"
|
| 778 |
+
}
|
| 779 |
+
},
|
| 780 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
| 781 |
+
"httpMethod": "GET",
|
| 782 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 783 |
+
"parameterOrder": [
|
| 784 |
+
"name"
|
| 785 |
+
]
|
| 786 |
+
}
|
| 787 |
+
}
|
| 788 |
+
},
|
| 789 |
+
"reservationGrants": {
|
| 790 |
+
"methods": {
|
| 791 |
+
"list": {
|
| 792 |
+
"response": {
|
| 793 |
+
"$ref": "ListReservationGrantsResponse"
|
| 794 |
+
},
|
| 795 |
+
"scopes": [
|
| 796 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 797 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 798 |
+
],
|
| 799 |
+
"parameters": {
|
| 800 |
+
"pageToken": {
|
| 801 |
+
"type": "string",
|
| 802 |
+
"location": "query",
|
| 803 |
+
"description": "The next_page_token value returned from a previous List request, if any."
|
| 804 |
+
},
|
| 805 |
+
"parent": {
|
| 806 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 807 |
+
"required": true,
|
| 808 |
+
"location": "path",
|
| 809 |
+
"type": "string",
|
| 810 |
+
"description": "The parent resource name e.g.: projects/myproject/location/eu."
|
| 811 |
+
},
|
| 812 |
+
"pageSize": {
|
| 813 |
+
"type": "integer",
|
| 814 |
+
"format": "int32",
|
| 815 |
+
"location": "query",
|
| 816 |
+
"description": "The maximum number of items to return."
|
| 817 |
+
}
|
| 818 |
+
},
|
| 819 |
+
"parameterOrder": [
|
| 820 |
+
"parent"
|
| 821 |
+
],
|
| 822 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants",
|
| 823 |
+
"httpMethod": "GET",
|
| 824 |
+
"path": "v1alpha2/{+parent}/reservationGrants",
|
| 825 |
+
"description": "Lists reservation grants. Only explicitly created grants will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateReservationGrant was invoked previously and following grants were created explicitly: Then this API will just return the above two grants for reservation res1, and no expansion/merge will happen.",
|
| 826 |
+
"id": "bigqueryreservation.projects.locations.reservationGrants.list"
|
| 827 |
+
},
|
| 828 |
+
"create": {
|
| 829 |
+
"httpMethod": "POST",
|
| 830 |
+
"path": "v1alpha2/{+parent}/reservationGrants",
|
| 831 |
+
"id": "bigqueryreservation.projects.locations.reservationGrants.create",
|
| 832 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants",
|
| 833 |
+
"description": "Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the grant does not match location of the reservation.",
|
| 834 |
+
"request": {
|
| 835 |
+
"$ref": "ReservationGrant"
|
| 836 |
+
},
|
| 837 |
+
"parameters": {
|
| 838 |
+
"parent": {
|
| 839 |
+
"description": "The parent resource name of the reservation grant E.g.: projects/myproject/location/eu.",
|
| 840 |
+
"required": true,
|
| 841 |
+
"location": "path",
|
| 842 |
+
"type": "string",
|
| 843 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$"
|
| 844 |
+
}
|
| 845 |
+
},
|
| 846 |
+
"scopes": [
|
| 847 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 848 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 849 |
+
],
|
| 850 |
+
"parameterOrder": [
|
| 851 |
+
"parent"
|
| 852 |
+
],
|
| 853 |
+
"response": {
|
| 854 |
+
"$ref": "ReservationGrant"
|
| 855 |
+
}
|
| 856 |
+
},
|
| 857 |
+
"delete": {
|
| 858 |
+
"response": {
|
| 859 |
+
"$ref": "Empty"
|
| 860 |
+
},
|
| 861 |
+
"description": "Deletes a reservation grant. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateReservationGrant was invoked previously and following grants were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.",
|
| 862 |
+
"path": "v1alpha2/{+name}",
|
| 863 |
+
"parameterOrder": [
|
| 864 |
+
"name"
|
| 865 |
+
],
|
| 866 |
+
"parameters": {
|
| 867 |
+
"name": {
|
| 868 |
+
"type": "string",
|
| 869 |
+
"description": "Name of the resource, e.g.: projects/myproject/locations/eu/reservationGrants/123",
|
| 870 |
+
"location": "path",
|
| 871 |
+
"required": true,
|
| 872 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/reservationGrants/[^/]+$"
|
| 873 |
+
}
|
| 874 |
+
},
|
| 875 |
+
"httpMethod": "DELETE",
|
| 876 |
+
"scopes": [
|
| 877 |
+
"https://www.googleapis.com/auth/bigquery",
|
| 878 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 879 |
+
],
|
| 880 |
+
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants/{reservationGrantsId}",
|
| 881 |
+
"id": "bigqueryreservation.projects.locations.reservationGrants.delete"
|
| 882 |
+
}
|
| 883 |
+
}
|
| 884 |
+
}
|
| 885 |
+
}
|
| 886 |
+
}
|
| 887 |
+
}
|
| 888 |
+
}
|
| 889 |
+
},
|
| 890 |
+
"name": "bigqueryreservation",
|
| 891 |
+
"servicePath": "",
|
| 892 |
+
"fullyEncodeReservedExpansion": true,
|
| 893 |
+
"baseUrl": "https://bigqueryreservation.googleapis.com/",
|
| 894 |
+
"basePath": "",
|
| 895 |
+
"id": "bigqueryreservation:v1alpha2",
|
| 896 |
+
"icons": {
|
| 897 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 898 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 899 |
+
},
|
| 900 |
+
"rootUrl": "https://bigqueryreservation.googleapis.com/",
|
| 901 |
+
"mtlsRootUrl": "https://bigqueryreservation.mtls.googleapis.com/",
|
| 902 |
+
"ownerDomain": "google.com",
|
| 903 |
+
"discoveryVersion": "v1"
|
| 904 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/billingbudgets.v1.json
ADDED
|
@@ -0,0 +1,585 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-billing": {
|
| 6 |
+
"description": "View and manage your Google Cloud Platform billing accounts"
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 9 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://billingbudgets.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "CloudBillingBudget",
|
| 18 |
+
"description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "billingbudgets:v1",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://billingbudgets.mtls.googleapis.com/",
|
| 29 |
+
"name": "billingbudgets",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"parameters": {
|
| 33 |
+
"$.xgafv": {
|
| 34 |
+
"description": "V1 error format.",
|
| 35 |
+
"enum": [
|
| 36 |
+
"1",
|
| 37 |
+
"2"
|
| 38 |
+
],
|
| 39 |
+
"enumDescriptions": [
|
| 40 |
+
"v1 error format",
|
| 41 |
+
"v2 error format"
|
| 42 |
+
],
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"access_token": {
|
| 47 |
+
"description": "OAuth access token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"alt": {
|
| 52 |
+
"default": "json",
|
| 53 |
+
"description": "Data format for response.",
|
| 54 |
+
"enum": [
|
| 55 |
+
"json",
|
| 56 |
+
"media",
|
| 57 |
+
"proto"
|
| 58 |
+
],
|
| 59 |
+
"enumDescriptions": [
|
| 60 |
+
"Responses with Content-Type of application/json",
|
| 61 |
+
"Media download with context-dependent Content-Type",
|
| 62 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 63 |
+
],
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"callback": {
|
| 68 |
+
"description": "JSONP",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
},
|
| 72 |
+
"fields": {
|
| 73 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 74 |
+
"location": "query",
|
| 75 |
+
"type": "string"
|
| 76 |
+
},
|
| 77 |
+
"key": {
|
| 78 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 79 |
+
"location": "query",
|
| 80 |
+
"type": "string"
|
| 81 |
+
},
|
| 82 |
+
"oauth_token": {
|
| 83 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 84 |
+
"location": "query",
|
| 85 |
+
"type": "string"
|
| 86 |
+
},
|
| 87 |
+
"prettyPrint": {
|
| 88 |
+
"default": "true",
|
| 89 |
+
"description": "Returns response with indentations and line breaks.",
|
| 90 |
+
"location": "query",
|
| 91 |
+
"type": "boolean"
|
| 92 |
+
},
|
| 93 |
+
"quotaUser": {
|
| 94 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 95 |
+
"location": "query",
|
| 96 |
+
"type": "string"
|
| 97 |
+
},
|
| 98 |
+
"uploadType": {
|
| 99 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 100 |
+
"location": "query",
|
| 101 |
+
"type": "string"
|
| 102 |
+
},
|
| 103 |
+
"upload_protocol": {
|
| 104 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 105 |
+
"location": "query",
|
| 106 |
+
"type": "string"
|
| 107 |
+
}
|
| 108 |
+
},
|
| 109 |
+
"protocol": "rest",
|
| 110 |
+
"resources": {
|
| 111 |
+
"billingAccounts": {
|
| 112 |
+
"resources": {
|
| 113 |
+
"budgets": {
|
| 114 |
+
"methods": {
|
| 115 |
+
"create": {
|
| 116 |
+
"description": "Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.",
|
| 117 |
+
"flatPath": "v1/billingAccounts/{billingAccountsId}/budgets",
|
| 118 |
+
"httpMethod": "POST",
|
| 119 |
+
"id": "billingbudgets.billingAccounts.budgets.create",
|
| 120 |
+
"parameterOrder": [
|
| 121 |
+
"parent"
|
| 122 |
+
],
|
| 123 |
+
"parameters": {
|
| 124 |
+
"parent": {
|
| 125 |
+
"description": "Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`.",
|
| 126 |
+
"location": "path",
|
| 127 |
+
"pattern": "^billingAccounts/[^/]+$",
|
| 128 |
+
"required": true,
|
| 129 |
+
"type": "string"
|
| 130 |
+
}
|
| 131 |
+
},
|
| 132 |
+
"path": "v1/{+parent}/budgets",
|
| 133 |
+
"request": {
|
| 134 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 135 |
+
},
|
| 136 |
+
"response": {
|
| 137 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 138 |
+
},
|
| 139 |
+
"scopes": [
|
| 140 |
+
"https://www.googleapis.com/auth/cloud-billing",
|
| 141 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 142 |
+
]
|
| 143 |
+
},
|
| 144 |
+
"delete": {
|
| 145 |
+
"description": "Deletes a budget. Returns successfully if already deleted.",
|
| 146 |
+
"flatPath": "v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
| 147 |
+
"httpMethod": "DELETE",
|
| 148 |
+
"id": "billingbudgets.billingAccounts.budgets.delete",
|
| 149 |
+
"parameterOrder": [
|
| 150 |
+
"name"
|
| 151 |
+
],
|
| 152 |
+
"parameters": {
|
| 153 |
+
"name": {
|
| 154 |
+
"description": "Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
| 155 |
+
"location": "path",
|
| 156 |
+
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
| 157 |
+
"required": true,
|
| 158 |
+
"type": "string"
|
| 159 |
+
}
|
| 160 |
+
},
|
| 161 |
+
"path": "v1/{+name}",
|
| 162 |
+
"response": {
|
| 163 |
+
"$ref": "GoogleProtobufEmpty"
|
| 164 |
+
},
|
| 165 |
+
"scopes": [
|
| 166 |
+
"https://www.googleapis.com/auth/cloud-billing",
|
| 167 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 168 |
+
]
|
| 169 |
+
},
|
| 170 |
+
"get": {
|
| 171 |
+
"description": "Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.",
|
| 172 |
+
"flatPath": "v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
| 173 |
+
"httpMethod": "GET",
|
| 174 |
+
"id": "billingbudgets.billingAccounts.budgets.get",
|
| 175 |
+
"parameterOrder": [
|
| 176 |
+
"name"
|
| 177 |
+
],
|
| 178 |
+
"parameters": {
|
| 179 |
+
"name": {
|
| 180 |
+
"description": "Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
| 181 |
+
"location": "path",
|
| 182 |
+
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
| 183 |
+
"required": true,
|
| 184 |
+
"type": "string"
|
| 185 |
+
}
|
| 186 |
+
},
|
| 187 |
+
"path": "v1/{+name}",
|
| 188 |
+
"response": {
|
| 189 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 190 |
+
},
|
| 191 |
+
"scopes": [
|
| 192 |
+
"https://www.googleapis.com/auth/cloud-billing",
|
| 193 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 194 |
+
]
|
| 195 |
+
},
|
| 196 |
+
"list": {
|
| 197 |
+
"description": "Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.",
|
| 198 |
+
"flatPath": "v1/billingAccounts/{billingAccountsId}/budgets",
|
| 199 |
+
"httpMethod": "GET",
|
| 200 |
+
"id": "billingbudgets.billingAccounts.budgets.list",
|
| 201 |
+
"parameterOrder": [
|
| 202 |
+
"parent"
|
| 203 |
+
],
|
| 204 |
+
"parameters": {
|
| 205 |
+
"pageSize": {
|
| 206 |
+
"description": "Optional. The maximum number of budgets to return per page. The default and maximum value are 100.",
|
| 207 |
+
"format": "int32",
|
| 208 |
+
"location": "query",
|
| 209 |
+
"type": "integer"
|
| 210 |
+
},
|
| 211 |
+
"pageToken": {
|
| 212 |
+
"description": "Optional. The value returned by the last `ListBudgetsResponse` which indicates that this is a continuation of a prior `ListBudgets` call, and that the system should return the next page of data.",
|
| 213 |
+
"location": "query",
|
| 214 |
+
"type": "string"
|
| 215 |
+
},
|
| 216 |
+
"parent": {
|
| 217 |
+
"description": "Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`.",
|
| 218 |
+
"location": "path",
|
| 219 |
+
"pattern": "^billingAccounts/[^/]+$",
|
| 220 |
+
"required": true,
|
| 221 |
+
"type": "string"
|
| 222 |
+
},
|
| 223 |
+
"scope": {
|
| 224 |
+
"description": "Optional. Set the scope of the budgets to be returned, in the format of the resource name. The scope of a budget is the cost that it tracks, such as costs for a single project, or the costs for all projects in a folder. Only project scope (in the format of \"projects/project-id\" or \"projects/123\") is supported in this field. When this field is set to a project's resource name, the budgets returned are tracking the costs for that project.",
|
| 225 |
+
"location": "query",
|
| 226 |
+
"type": "string"
|
| 227 |
+
}
|
| 228 |
+
},
|
| 229 |
+
"path": "v1/{+parent}/budgets",
|
| 230 |
+
"response": {
|
| 231 |
+
"$ref": "GoogleCloudBillingBudgetsV1ListBudgetsResponse"
|
| 232 |
+
},
|
| 233 |
+
"scopes": [
|
| 234 |
+
"https://www.googleapis.com/auth/cloud-billing",
|
| 235 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 236 |
+
]
|
| 237 |
+
},
|
| 238 |
+
"patch": {
|
| 239 |
+
"description": "Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.",
|
| 240 |
+
"flatPath": "v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
| 241 |
+
"httpMethod": "PATCH",
|
| 242 |
+
"id": "billingbudgets.billingAccounts.budgets.patch",
|
| 243 |
+
"parameterOrder": [
|
| 244 |
+
"name"
|
| 245 |
+
],
|
| 246 |
+
"parameters": {
|
| 247 |
+
"name": {
|
| 248 |
+
"description": "Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
| 249 |
+
"location": "path",
|
| 250 |
+
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
| 251 |
+
"required": true,
|
| 252 |
+
"type": "string"
|
| 253 |
+
},
|
| 254 |
+
"updateMask": {
|
| 255 |
+
"description": "Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.",
|
| 256 |
+
"format": "google-fieldmask",
|
| 257 |
+
"location": "query",
|
| 258 |
+
"type": "string"
|
| 259 |
+
}
|
| 260 |
+
},
|
| 261 |
+
"path": "v1/{+name}",
|
| 262 |
+
"request": {
|
| 263 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 264 |
+
},
|
| 265 |
+
"response": {
|
| 266 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 267 |
+
},
|
| 268 |
+
"scopes": [
|
| 269 |
+
"https://www.googleapis.com/auth/cloud-billing",
|
| 270 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 271 |
+
]
|
| 272 |
+
}
|
| 273 |
+
}
|
| 274 |
+
}
|
| 275 |
+
}
|
| 276 |
+
}
|
| 277 |
+
},
|
| 278 |
+
"revision": "20240707",
|
| 279 |
+
"rootUrl": "https://billingbudgets.googleapis.com/",
|
| 280 |
+
"schemas": {
|
| 281 |
+
"GoogleCloudBillingBudgetsV1Budget": {
|
| 282 |
+
"description": "A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.",
|
| 283 |
+
"id": "GoogleCloudBillingBudgetsV1Budget",
|
| 284 |
+
"properties": {
|
| 285 |
+
"amount": {
|
| 286 |
+
"$ref": "GoogleCloudBillingBudgetsV1BudgetAmount",
|
| 287 |
+
"description": "Required. Budgeted amount."
|
| 288 |
+
},
|
| 289 |
+
"budgetFilter": {
|
| 290 |
+
"$ref": "GoogleCloudBillingBudgetsV1Filter",
|
| 291 |
+
"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters."
|
| 292 |
+
},
|
| 293 |
+
"displayName": {
|
| 294 |
+
"description": "User data for display name in UI. The name must be less than or equal to 60 characters.",
|
| 295 |
+
"type": "string"
|
| 296 |
+
},
|
| 297 |
+
"etag": {
|
| 298 |
+
"description": "Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes.",
|
| 299 |
+
"type": "string"
|
| 300 |
+
},
|
| 301 |
+
"name": {
|
| 302 |
+
"description": "Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
| 303 |
+
"readOnly": true,
|
| 304 |
+
"type": "string"
|
| 305 |
+
},
|
| 306 |
+
"notificationsRule": {
|
| 307 |
+
"$ref": "GoogleCloudBillingBudgetsV1NotificationsRule",
|
| 308 |
+
"description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds."
|
| 309 |
+
},
|
| 310 |
+
"ownershipScope": {
|
| 311 |
+
"enum": [
|
| 312 |
+
"OWNERSHIP_SCOPE_UNSPECIFIED",
|
| 313 |
+
"ALL_USERS",
|
| 314 |
+
"BILLING_ACCOUNT"
|
| 315 |
+
],
|
| 316 |
+
"enumDescriptions": [
|
| 317 |
+
"Unspecified ownership scope, same as ALL_USERS.",
|
| 318 |
+
"Both billing account-level users and project-level users have full access to the budget, if the users have the required IAM permissions.",
|
| 319 |
+
"Only billing account-level users have full access to the budget. Project-level users have read-only access, even if they have the required IAM permissions."
|
| 320 |
+
],
|
| 321 |
+
"type": "string"
|
| 322 |
+
},
|
| 323 |
+
"thresholdRules": {
|
| 324 |
+
"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications.",
|
| 325 |
+
"items": {
|
| 326 |
+
"$ref": "GoogleCloudBillingBudgetsV1ThresholdRule"
|
| 327 |
+
},
|
| 328 |
+
"type": "array"
|
| 329 |
+
}
|
| 330 |
+
},
|
| 331 |
+
"type": "object"
|
| 332 |
+
},
|
| 333 |
+
"GoogleCloudBillingBudgetsV1BudgetAmount": {
|
| 334 |
+
"description": "The budgeted amount for each usage period.",
|
| 335 |
+
"id": "GoogleCloudBillingBudgetsV1BudgetAmount",
|
| 336 |
+
"properties": {
|
| 337 |
+
"lastPeriodAmount": {
|
| 338 |
+
"$ref": "GoogleCloudBillingBudgetsV1LastPeriodAmount",
|
| 339 |
+
"description": "Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
|
| 340 |
+
},
|
| 341 |
+
"specifiedAmount": {
|
| 342 |
+
"$ref": "GoogleTypeMoney",
|
| 343 |
+
"description": "A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output."
|
| 344 |
+
}
|
| 345 |
+
},
|
| 346 |
+
"type": "object"
|
| 347 |
+
},
|
| 348 |
+
"GoogleCloudBillingBudgetsV1CustomPeriod": {
|
| 349 |
+
"description": "All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).",
|
| 350 |
+
"id": "GoogleCloudBillingBudgetsV1CustomPeriod",
|
| 351 |
+
"properties": {
|
| 352 |
+
"endDate": {
|
| 353 |
+
"$ref": "GoogleTypeDate",
|
| 354 |
+
"description": "Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date."
|
| 355 |
+
},
|
| 356 |
+
"startDate": {
|
| 357 |
+
"$ref": "GoogleTypeDate",
|
| 358 |
+
"description": "Required. The start date must be after January 1, 2017."
|
| 359 |
+
}
|
| 360 |
+
},
|
| 361 |
+
"type": "object"
|
| 362 |
+
},
|
| 363 |
+
"GoogleCloudBillingBudgetsV1Filter": {
|
| 364 |
+
"description": "A filter for a budget, limiting the scope of the cost to calculate.",
|
| 365 |
+
"id": "GoogleCloudBillingBudgetsV1Filter",
|
| 366 |
+
"properties": {
|
| 367 |
+
"calendarPeriod": {
|
| 368 |
+
"description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.",
|
| 369 |
+
"enum": [
|
| 370 |
+
"CALENDAR_PERIOD_UNSPECIFIED",
|
| 371 |
+
"MONTH",
|
| 372 |
+
"QUARTER",
|
| 373 |
+
"YEAR"
|
| 374 |
+
],
|
| 375 |
+
"enumDescriptions": [
|
| 376 |
+
"Calendar period is unset. This is the default if the budget is for a custom time period (CustomPeriod).",
|
| 377 |
+
"A month. Month starts on the first day of each month, such as January 1, February 1, March 1, and so on.",
|
| 378 |
+
"A quarter. Quarters start on dates January 1, April 1, July 1, and October 1 of each year.",
|
| 379 |
+
"A year. Year starts on January 1."
|
| 380 |
+
],
|
| 381 |
+
"type": "string"
|
| 382 |
+
},
|
| 383 |
+
"creditTypes": {
|
| 384 |
+
"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.",
|
| 385 |
+
"items": {
|
| 386 |
+
"type": "string"
|
| 387 |
+
},
|
| 388 |
+
"type": "array"
|
| 389 |
+
},
|
| 390 |
+
"creditTypesTreatment": {
|
| 391 |
+
"description": "Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.",
|
| 392 |
+
"enum": [
|
| 393 |
+
"CREDIT_TYPES_TREATMENT_UNSPECIFIED",
|
| 394 |
+
"INCLUDE_ALL_CREDITS",
|
| 395 |
+
"EXCLUDE_ALL_CREDITS",
|
| 396 |
+
"INCLUDE_SPECIFIED_CREDITS"
|
| 397 |
+
],
|
| 398 |
+
"enumDescriptions": [
|
| 399 |
+
"",
|
| 400 |
+
"All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.",
|
| 401 |
+
"All types of credit are added to the net cost to determine the spend for threshold calculations.",
|
| 402 |
+
"[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations."
|
| 403 |
+
],
|
| 404 |
+
"type": "string"
|
| 405 |
+
},
|
| 406 |
+
"customPeriod": {
|
| 407 |
+
"$ref": "GoogleCloudBillingBudgetsV1CustomPeriod",
|
| 408 |
+
"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur."
|
| 409 |
+
},
|
| 410 |
+
"labels": {
|
| 411 |
+
"additionalProperties": {
|
| 412 |
+
"items": {
|
| 413 |
+
"type": "any"
|
| 414 |
+
},
|
| 415 |
+
"type": "array"
|
| 416 |
+
},
|
| 417 |
+
"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `\"key\": value` pair. Example: `{ \"name\": \"wrench\" }`. _Currently, multiple entries or multiple values per entry are not allowed._",
|
| 418 |
+
"type": "object"
|
| 419 |
+
},
|
| 420 |
+
"projects": {
|
| 421 |
+
"description": "Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on.",
|
| 422 |
+
"items": {
|
| 423 |
+
"type": "string"
|
| 424 |
+
},
|
| 425 |
+
"type": "array"
|
| 426 |
+
},
|
| 427 |
+
"resourceAncestors": {
|
| 428 |
+
"description": "Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects.",
|
| 429 |
+
"items": {
|
| 430 |
+
"type": "string"
|
| 431 |
+
},
|
| 432 |
+
"type": "array"
|
| 433 |
+
},
|
| 434 |
+
"services": {
|
| 435 |
+
"description": "Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.",
|
| 436 |
+
"items": {
|
| 437 |
+
"type": "string"
|
| 438 |
+
},
|
| 439 |
+
"type": "array"
|
| 440 |
+
},
|
| 441 |
+
"subaccounts": {
|
| 442 |
+
"description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.",
|
| 443 |
+
"items": {
|
| 444 |
+
"type": "string"
|
| 445 |
+
},
|
| 446 |
+
"type": "array"
|
| 447 |
+
}
|
| 448 |
+
},
|
| 449 |
+
"type": "object"
|
| 450 |
+
},
|
| 451 |
+
"GoogleCloudBillingBudgetsV1LastPeriodAmount": {
|
| 452 |
+
"description": "Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.",
|
| 453 |
+
"id": "GoogleCloudBillingBudgetsV1LastPeriodAmount",
|
| 454 |
+
"properties": {},
|
| 455 |
+
"type": "object"
|
| 456 |
+
},
|
| 457 |
+
"GoogleCloudBillingBudgetsV1ListBudgetsResponse": {
|
| 458 |
+
"description": "Response for ListBudgets",
|
| 459 |
+
"id": "GoogleCloudBillingBudgetsV1ListBudgetsResponse",
|
| 460 |
+
"properties": {
|
| 461 |
+
"budgets": {
|
| 462 |
+
"description": "List of the budgets owned by the requested billing account.",
|
| 463 |
+
"items": {
|
| 464 |
+
"$ref": "GoogleCloudBillingBudgetsV1Budget"
|
| 465 |
+
},
|
| 466 |
+
"type": "array"
|
| 467 |
+
},
|
| 468 |
+
"nextPageToken": {
|
| 469 |
+
"description": "If not empty, indicates that there may be more budgets that match the request; this value should be passed in a new `ListBudgetsRequest`.",
|
| 470 |
+
"type": "string"
|
| 471 |
+
}
|
| 472 |
+
},
|
| 473 |
+
"type": "object"
|
| 474 |
+
},
|
| 475 |
+
"GoogleCloudBillingBudgetsV1NotificationsRule": {
|
| 476 |
+
"description": "NotificationsRule defines notifications that are sent based on budget spend and thresholds.",
|
| 477 |
+
"id": "GoogleCloudBillingBudgetsV1NotificationsRule",
|
| 478 |
+
"properties": {
|
| 479 |
+
"disableDefaultIamRecipients": {
|
| 480 |
+
"description": "Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.",
|
| 481 |
+
"type": "boolean"
|
| 482 |
+
},
|
| 483 |
+
"enableProjectLevelRecipients": {
|
| 484 |
+
"description": "Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project.",
|
| 485 |
+
"type": "boolean"
|
| 486 |
+
},
|
| 487 |
+
"monitoringNotificationChannels": {
|
| 488 |
+
"description": "Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).",
|
| 489 |
+
"items": {
|
| 490 |
+
"type": "string"
|
| 491 |
+
},
|
| 492 |
+
"type": "array"
|
| 493 |
+
},
|
| 494 |
+
"pubsubTopic": {
|
| 495 |
+
"description": "Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).",
|
| 496 |
+
"type": "string"
|
| 497 |
+
},
|
| 498 |
+
"schemaVersion": {
|
| 499 |
+
"description": "Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only \"1.0\" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.",
|
| 500 |
+
"type": "string"
|
| 501 |
+
}
|
| 502 |
+
},
|
| 503 |
+
"type": "object"
|
| 504 |
+
},
|
| 505 |
+
"GoogleCloudBillingBudgetsV1ThresholdRule": {
|
| 506 |
+
"description": "ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).",
|
| 507 |
+
"id": "GoogleCloudBillingBudgetsV1ThresholdRule",
|
| 508 |
+
"properties": {
|
| 509 |
+
"spendBasis": {
|
| 510 |
+
"description": "Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.",
|
| 511 |
+
"enum": [
|
| 512 |
+
"BASIS_UNSPECIFIED",
|
| 513 |
+
"CURRENT_SPEND",
|
| 514 |
+
"FORECASTED_SPEND"
|
| 515 |
+
],
|
| 516 |
+
"enumDescriptions": [
|
| 517 |
+
"Unspecified threshold basis.",
|
| 518 |
+
"Use current spend as the basis for comparison against the threshold.",
|
| 519 |
+
"Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
|
| 520 |
+
],
|
| 521 |
+
"type": "string"
|
| 522 |
+
},
|
| 523 |
+
"thresholdPercent": {
|
| 524 |
+
"description": "Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.",
|
| 525 |
+
"format": "double",
|
| 526 |
+
"type": "number"
|
| 527 |
+
}
|
| 528 |
+
},
|
| 529 |
+
"type": "object"
|
| 530 |
+
},
|
| 531 |
+
"GoogleProtobufEmpty": {
|
| 532 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 533 |
+
"id": "GoogleProtobufEmpty",
|
| 534 |
+
"properties": {},
|
| 535 |
+
"type": "object"
|
| 536 |
+
},
|
| 537 |
+
"GoogleTypeDate": {
|
| 538 |
+
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
|
| 539 |
+
"id": "GoogleTypeDate",
|
| 540 |
+
"properties": {
|
| 541 |
+
"day": {
|
| 542 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 543 |
+
"format": "int32",
|
| 544 |
+
"type": "integer"
|
| 545 |
+
},
|
| 546 |
+
"month": {
|
| 547 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 548 |
+
"format": "int32",
|
| 549 |
+
"type": "integer"
|
| 550 |
+
},
|
| 551 |
+
"year": {
|
| 552 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 553 |
+
"format": "int32",
|
| 554 |
+
"type": "integer"
|
| 555 |
+
}
|
| 556 |
+
},
|
| 557 |
+
"type": "object"
|
| 558 |
+
},
|
| 559 |
+
"GoogleTypeMoney": {
|
| 560 |
+
"description": "Represents an amount of money with its currency type.",
|
| 561 |
+
"id": "GoogleTypeMoney",
|
| 562 |
+
"properties": {
|
| 563 |
+
"currencyCode": {
|
| 564 |
+
"description": "The three-letter currency code defined in ISO 4217.",
|
| 565 |
+
"type": "string"
|
| 566 |
+
},
|
| 567 |
+
"nanos": {
|
| 568 |
+
"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
|
| 569 |
+
"format": "int32",
|
| 570 |
+
"type": "integer"
|
| 571 |
+
},
|
| 572 |
+
"units": {
|
| 573 |
+
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
|
| 574 |
+
"format": "int64",
|
| 575 |
+
"type": "string"
|
| 576 |
+
}
|
| 577 |
+
},
|
| 578 |
+
"type": "object"
|
| 579 |
+
}
|
| 580 |
+
},
|
| 581 |
+
"servicePath": "",
|
| 582 |
+
"title": "Cloud Billing Budget API",
|
| 583 |
+
"version": "v1",
|
| 584 |
+
"version_module": true
|
| 585 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
ADDED
|
@@ -0,0 +1,1925 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://binaryauthorization.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Binary Authorization",
|
| 15 |
+
"description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run. ",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/binary-authorization/",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "binaryauthorization:v1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://binaryauthorization.mtls.googleapis.com/",
|
| 26 |
+
"name": "binaryauthorization",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"projects": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"getPolicy": {
|
| 111 |
+
"description": "A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one.",
|
| 112 |
+
"flatPath": "v1/projects/{projectsId}/policy",
|
| 113 |
+
"httpMethod": "GET",
|
| 114 |
+
"id": "binaryauthorization.projects.getPolicy",
|
| 115 |
+
"parameterOrder": [
|
| 116 |
+
"name"
|
| 117 |
+
],
|
| 118 |
+
"parameters": {
|
| 119 |
+
"name": {
|
| 120 |
+
"description": "Required. The resource name of the policy to retrieve, in the format `projects/*/policy`.",
|
| 121 |
+
"location": "path",
|
| 122 |
+
"pattern": "^projects/[^/]+/policy$",
|
| 123 |
+
"required": true,
|
| 124 |
+
"type": "string"
|
| 125 |
+
}
|
| 126 |
+
},
|
| 127 |
+
"path": "v1/{+name}",
|
| 128 |
+
"response": {
|
| 129 |
+
"$ref": "Policy"
|
| 130 |
+
},
|
| 131 |
+
"scopes": [
|
| 132 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 133 |
+
]
|
| 134 |
+
},
|
| 135 |
+
"updatePolicy": {
|
| 136 |
+
"description": "Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns `NOT_FOUND` if the project does not exist, `INVALID_ARGUMENT` if the request is malformed.",
|
| 137 |
+
"flatPath": "v1/projects/{projectsId}/policy",
|
| 138 |
+
"httpMethod": "PUT",
|
| 139 |
+
"id": "binaryauthorization.projects.updatePolicy",
|
| 140 |
+
"parameterOrder": [
|
| 141 |
+
"name"
|
| 142 |
+
],
|
| 143 |
+
"parameters": {
|
| 144 |
+
"name": {
|
| 145 |
+
"description": "Output only. The resource name, in the format `projects/*/policy`. There is at most one policy per project.",
|
| 146 |
+
"location": "path",
|
| 147 |
+
"pattern": "^projects/[^/]+/policy$",
|
| 148 |
+
"required": true,
|
| 149 |
+
"type": "string"
|
| 150 |
+
}
|
| 151 |
+
},
|
| 152 |
+
"path": "v1/{+name}",
|
| 153 |
+
"request": {
|
| 154 |
+
"$ref": "Policy"
|
| 155 |
+
},
|
| 156 |
+
"response": {
|
| 157 |
+
"$ref": "Policy"
|
| 158 |
+
},
|
| 159 |
+
"scopes": [
|
| 160 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 161 |
+
]
|
| 162 |
+
}
|
| 163 |
+
},
|
| 164 |
+
"resources": {
|
| 165 |
+
"attestors": {
|
| 166 |
+
"methods": {
|
| 167 |
+
"create": {
|
| 168 |
+
"description": "Creates an attestor, and returns a copy of the new attestor. Returns `NOT_FOUND` if the project does not exist, `INVALID_ARGUMENT` if the request is malformed, `ALREADY_EXISTS` if the attestor already exists.",
|
| 169 |
+
"flatPath": "v1/projects/{projectsId}/attestors",
|
| 170 |
+
"httpMethod": "POST",
|
| 171 |
+
"id": "binaryauthorization.projects.attestors.create",
|
| 172 |
+
"parameterOrder": [
|
| 173 |
+
"parent"
|
| 174 |
+
],
|
| 175 |
+
"parameters": {
|
| 176 |
+
"attestorId": {
|
| 177 |
+
"description": "Required. The attestors ID.",
|
| 178 |
+
"location": "query",
|
| 179 |
+
"type": "string"
|
| 180 |
+
},
|
| 181 |
+
"parent": {
|
| 182 |
+
"description": "Required. The parent of this attestor.",
|
| 183 |
+
"location": "path",
|
| 184 |
+
"pattern": "^projects/[^/]+$",
|
| 185 |
+
"required": true,
|
| 186 |
+
"type": "string"
|
| 187 |
+
}
|
| 188 |
+
},
|
| 189 |
+
"path": "v1/{+parent}/attestors",
|
| 190 |
+
"request": {
|
| 191 |
+
"$ref": "Attestor"
|
| 192 |
+
},
|
| 193 |
+
"response": {
|
| 194 |
+
"$ref": "Attestor"
|
| 195 |
+
},
|
| 196 |
+
"scopes": [
|
| 197 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 198 |
+
]
|
| 199 |
+
},
|
| 200 |
+
"delete": {
|
| 201 |
+
"description": "Deletes an attestor. Returns `NOT_FOUND` if the attestor does not exist.",
|
| 202 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
| 203 |
+
"httpMethod": "DELETE",
|
| 204 |
+
"id": "binaryauthorization.projects.attestors.delete",
|
| 205 |
+
"parameterOrder": [
|
| 206 |
+
"name"
|
| 207 |
+
],
|
| 208 |
+
"parameters": {
|
| 209 |
+
"name": {
|
| 210 |
+
"description": "Required. The name of the attestors to delete, in the format `projects/*/attestors/*`.",
|
| 211 |
+
"location": "path",
|
| 212 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 213 |
+
"required": true,
|
| 214 |
+
"type": "string"
|
| 215 |
+
}
|
| 216 |
+
},
|
| 217 |
+
"path": "v1/{+name}",
|
| 218 |
+
"response": {
|
| 219 |
+
"$ref": "Empty"
|
| 220 |
+
},
|
| 221 |
+
"scopes": [
|
| 222 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 223 |
+
]
|
| 224 |
+
},
|
| 225 |
+
"get": {
|
| 226 |
+
"description": "Gets an attestor. Returns `NOT_FOUND` if the attestor does not exist.",
|
| 227 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
| 228 |
+
"httpMethod": "GET",
|
| 229 |
+
"id": "binaryauthorization.projects.attestors.get",
|
| 230 |
+
"parameterOrder": [
|
| 231 |
+
"name"
|
| 232 |
+
],
|
| 233 |
+
"parameters": {
|
| 234 |
+
"name": {
|
| 235 |
+
"description": "Required. The name of the attestor to retrieve, in the format `projects/*/attestors/*`.",
|
| 236 |
+
"location": "path",
|
| 237 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 238 |
+
"required": true,
|
| 239 |
+
"type": "string"
|
| 240 |
+
}
|
| 241 |
+
},
|
| 242 |
+
"path": "v1/{+name}",
|
| 243 |
+
"response": {
|
| 244 |
+
"$ref": "Attestor"
|
| 245 |
+
},
|
| 246 |
+
"scopes": [
|
| 247 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 248 |
+
]
|
| 249 |
+
},
|
| 250 |
+
"getIamPolicy": {
|
| 251 |
+
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
|
| 252 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:getIamPolicy",
|
| 253 |
+
"httpMethod": "GET",
|
| 254 |
+
"id": "binaryauthorization.projects.attestors.getIamPolicy",
|
| 255 |
+
"parameterOrder": [
|
| 256 |
+
"resource"
|
| 257 |
+
],
|
| 258 |
+
"parameters": {
|
| 259 |
+
"options.requestedPolicyVersion": {
|
| 260 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 261 |
+
"format": "int32",
|
| 262 |
+
"location": "query",
|
| 263 |
+
"type": "integer"
|
| 264 |
+
},
|
| 265 |
+
"resource": {
|
| 266 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 267 |
+
"location": "path",
|
| 268 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 269 |
+
"required": true,
|
| 270 |
+
"type": "string"
|
| 271 |
+
}
|
| 272 |
+
},
|
| 273 |
+
"path": "v1/{+resource}:getIamPolicy",
|
| 274 |
+
"response": {
|
| 275 |
+
"$ref": "IamPolicy"
|
| 276 |
+
},
|
| 277 |
+
"scopes": [
|
| 278 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 279 |
+
]
|
| 280 |
+
},
|
| 281 |
+
"list": {
|
| 282 |
+
"description": "Lists attestors. Returns `INVALID_ARGUMENT` if the project does not exist.",
|
| 283 |
+
"flatPath": "v1/projects/{projectsId}/attestors",
|
| 284 |
+
"httpMethod": "GET",
|
| 285 |
+
"id": "binaryauthorization.projects.attestors.list",
|
| 286 |
+
"parameterOrder": [
|
| 287 |
+
"parent"
|
| 288 |
+
],
|
| 289 |
+
"parameters": {
|
| 290 |
+
"pageSize": {
|
| 291 |
+
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
|
| 292 |
+
"format": "int32",
|
| 293 |
+
"location": "query",
|
| 294 |
+
"type": "integer"
|
| 295 |
+
},
|
| 296 |
+
"pageToken": {
|
| 297 |
+
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the `ListAttestors` method.",
|
| 298 |
+
"location": "query",
|
| 299 |
+
"type": "string"
|
| 300 |
+
},
|
| 301 |
+
"parent": {
|
| 302 |
+
"description": "Required. The resource name of the project associated with the attestors, in the format `projects/*`.",
|
| 303 |
+
"location": "path",
|
| 304 |
+
"pattern": "^projects/[^/]+$",
|
| 305 |
+
"required": true,
|
| 306 |
+
"type": "string"
|
| 307 |
+
}
|
| 308 |
+
},
|
| 309 |
+
"path": "v1/{+parent}/attestors",
|
| 310 |
+
"response": {
|
| 311 |
+
"$ref": "ListAttestorsResponse"
|
| 312 |
+
},
|
| 313 |
+
"scopes": [
|
| 314 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 315 |
+
]
|
| 316 |
+
},
|
| 317 |
+
"setIamPolicy": {
|
| 318 |
+
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
|
| 319 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:setIamPolicy",
|
| 320 |
+
"httpMethod": "POST",
|
| 321 |
+
"id": "binaryauthorization.projects.attestors.setIamPolicy",
|
| 322 |
+
"parameterOrder": [
|
| 323 |
+
"resource"
|
| 324 |
+
],
|
| 325 |
+
"parameters": {
|
| 326 |
+
"resource": {
|
| 327 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 328 |
+
"location": "path",
|
| 329 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 330 |
+
"required": true,
|
| 331 |
+
"type": "string"
|
| 332 |
+
}
|
| 333 |
+
},
|
| 334 |
+
"path": "v1/{+resource}:setIamPolicy",
|
| 335 |
+
"request": {
|
| 336 |
+
"$ref": "SetIamPolicyRequest"
|
| 337 |
+
},
|
| 338 |
+
"response": {
|
| 339 |
+
"$ref": "IamPolicy"
|
| 340 |
+
},
|
| 341 |
+
"scopes": [
|
| 342 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 343 |
+
]
|
| 344 |
+
},
|
| 345 |
+
"testIamPermissions": {
|
| 346 |
+
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.",
|
| 347 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:testIamPermissions",
|
| 348 |
+
"httpMethod": "POST",
|
| 349 |
+
"id": "binaryauthorization.projects.attestors.testIamPermissions",
|
| 350 |
+
"parameterOrder": [
|
| 351 |
+
"resource"
|
| 352 |
+
],
|
| 353 |
+
"parameters": {
|
| 354 |
+
"resource": {
|
| 355 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 356 |
+
"location": "path",
|
| 357 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 358 |
+
"required": true,
|
| 359 |
+
"type": "string"
|
| 360 |
+
}
|
| 361 |
+
},
|
| 362 |
+
"path": "v1/{+resource}:testIamPermissions",
|
| 363 |
+
"request": {
|
| 364 |
+
"$ref": "TestIamPermissionsRequest"
|
| 365 |
+
},
|
| 366 |
+
"response": {
|
| 367 |
+
"$ref": "TestIamPermissionsResponse"
|
| 368 |
+
},
|
| 369 |
+
"scopes": [
|
| 370 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 371 |
+
]
|
| 372 |
+
},
|
| 373 |
+
"update": {
|
| 374 |
+
"description": "Updates an attestor. Returns `NOT_FOUND` if the attestor does not exist.",
|
| 375 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
| 376 |
+
"httpMethod": "PUT",
|
| 377 |
+
"id": "binaryauthorization.projects.attestors.update",
|
| 378 |
+
"parameterOrder": [
|
| 379 |
+
"name"
|
| 380 |
+
],
|
| 381 |
+
"parameters": {
|
| 382 |
+
"name": {
|
| 383 |
+
"description": "Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated.",
|
| 384 |
+
"location": "path",
|
| 385 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 386 |
+
"required": true,
|
| 387 |
+
"type": "string"
|
| 388 |
+
}
|
| 389 |
+
},
|
| 390 |
+
"path": "v1/{+name}",
|
| 391 |
+
"request": {
|
| 392 |
+
"$ref": "Attestor"
|
| 393 |
+
},
|
| 394 |
+
"response": {
|
| 395 |
+
"$ref": "Attestor"
|
| 396 |
+
},
|
| 397 |
+
"scopes": [
|
| 398 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 399 |
+
]
|
| 400 |
+
},
|
| 401 |
+
"validateAttestationOccurrence": {
|
| 402 |
+
"description": "Returns whether the given `Attestation` for the given image URI was signed by the given `Attestor`",
|
| 403 |
+
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:validateAttestationOccurrence",
|
| 404 |
+
"httpMethod": "POST",
|
| 405 |
+
"id": "binaryauthorization.projects.attestors.validateAttestationOccurrence",
|
| 406 |
+
"parameterOrder": [
|
| 407 |
+
"attestor"
|
| 408 |
+
],
|
| 409 |
+
"parameters": {
|
| 410 |
+
"attestor": {
|
| 411 |
+
"description": "Required. The resource name of the Attestor of the occurrence, in the format `projects/*/attestors/*`.",
|
| 412 |
+
"location": "path",
|
| 413 |
+
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
| 414 |
+
"required": true,
|
| 415 |
+
"type": "string"
|
| 416 |
+
}
|
| 417 |
+
},
|
| 418 |
+
"path": "v1/{+attestor}:validateAttestationOccurrence",
|
| 419 |
+
"request": {
|
| 420 |
+
"$ref": "ValidateAttestationOccurrenceRequest"
|
| 421 |
+
},
|
| 422 |
+
"response": {
|
| 423 |
+
"$ref": "ValidateAttestationOccurrenceResponse"
|
| 424 |
+
},
|
| 425 |
+
"scopes": [
|
| 426 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 427 |
+
]
|
| 428 |
+
}
|
| 429 |
+
}
|
| 430 |
+
},
|
| 431 |
+
"platforms": {
|
| 432 |
+
"resources": {
|
| 433 |
+
"gke": {
|
| 434 |
+
"resources": {
|
| 435 |
+
"policies": {
|
| 436 |
+
"methods": {
|
| 437 |
+
"evaluate": {
|
| 438 |
+
"description": "Evaluates a Kubernetes object versus a GKE platform policy. Returns `NOT_FOUND` if the policy doesn't exist, `INVALID_ARGUMENT` if the policy or request is malformed and `PERMISSION_DENIED` if the client does not have sufficient permissions.",
|
| 439 |
+
"flatPath": "v1/projects/{projectsId}/platforms/gke/policies/{policiesId}:evaluate",
|
| 440 |
+
"httpMethod": "POST",
|
| 441 |
+
"id": "binaryauthorization.projects.platforms.gke.policies.evaluate",
|
| 442 |
+
"parameterOrder": [
|
| 443 |
+
"name"
|
| 444 |
+
],
|
| 445 |
+
"parameters": {
|
| 446 |
+
"name": {
|
| 447 |
+
"description": "Required. The name of the platform policy to evaluate in the format `projects/*/platforms/*/policies/*`.",
|
| 448 |
+
"location": "path",
|
| 449 |
+
"pattern": "^projects/[^/]+/platforms/gke/policies/[^/]+$",
|
| 450 |
+
"required": true,
|
| 451 |
+
"type": "string"
|
| 452 |
+
}
|
| 453 |
+
},
|
| 454 |
+
"path": "v1/{+name}:evaluate",
|
| 455 |
+
"request": {
|
| 456 |
+
"$ref": "EvaluateGkePolicyRequest"
|
| 457 |
+
},
|
| 458 |
+
"response": {
|
| 459 |
+
"$ref": "EvaluateGkePolicyResponse"
|
| 460 |
+
},
|
| 461 |
+
"scopes": [
|
| 462 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 463 |
+
]
|
| 464 |
+
}
|
| 465 |
+
}
|
| 466 |
+
}
|
| 467 |
+
}
|
| 468 |
+
},
|
| 469 |
+
"policies": {
|
| 470 |
+
"methods": {
|
| 471 |
+
"create": {
|
| 472 |
+
"description": "Creates a platform policy, and returns a copy of it. Returns `NOT_FOUND` if the project or platform doesn't exist, `INVALID_ARGUMENT` if the request is malformed, `ALREADY_EXISTS` if the policy already exists, and `INVALID_ARGUMENT` if the policy contains a platform-specific policy that does not match the platform value specified in the URL.",
|
| 473 |
+
"flatPath": "v1/projects/{projectsId}/platforms/{platformsId}/policies",
|
| 474 |
+
"httpMethod": "POST",
|
| 475 |
+
"id": "binaryauthorization.projects.platforms.policies.create",
|
| 476 |
+
"parameterOrder": [
|
| 477 |
+
"parent"
|
| 478 |
+
],
|
| 479 |
+
"parameters": {
|
| 480 |
+
"parent": {
|
| 481 |
+
"description": "Required. The parent of this platform policy.",
|
| 482 |
+
"location": "path",
|
| 483 |
+
"pattern": "^projects/[^/]+/platforms/[^/]+$",
|
| 484 |
+
"required": true,
|
| 485 |
+
"type": "string"
|
| 486 |
+
},
|
| 487 |
+
"policyId": {
|
| 488 |
+
"description": "Required. The platform policy ID.",
|
| 489 |
+
"location": "query",
|
| 490 |
+
"type": "string"
|
| 491 |
+
}
|
| 492 |
+
},
|
| 493 |
+
"path": "v1/{+parent}/policies",
|
| 494 |
+
"request": {
|
| 495 |
+
"$ref": "PlatformPolicy"
|
| 496 |
+
},
|
| 497 |
+
"response": {
|
| 498 |
+
"$ref": "PlatformPolicy"
|
| 499 |
+
},
|
| 500 |
+
"scopes": [
|
| 501 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 502 |
+
]
|
| 503 |
+
},
|
| 504 |
+
"delete": {
|
| 505 |
+
"description": "Deletes a platform policy. Returns `NOT_FOUND` if the policy doesn't exist.",
|
| 506 |
+
"flatPath": "v1/projects/{projectsId}/platforms/{platformsId}/policies/{policiesId}",
|
| 507 |
+
"httpMethod": "DELETE",
|
| 508 |
+
"id": "binaryauthorization.projects.platforms.policies.delete",
|
| 509 |
+
"parameterOrder": [
|
| 510 |
+
"name"
|
| 511 |
+
],
|
| 512 |
+
"parameters": {
|
| 513 |
+
"etag": {
|
| 514 |
+
"description": "Optional. Used to prevent deleting the policy when another request has updated it since it was retrieved.",
|
| 515 |
+
"location": "query",
|
| 516 |
+
"type": "string"
|
| 517 |
+
},
|
| 518 |
+
"name": {
|
| 519 |
+
"description": "Required. The name of the platform policy to delete, in the format `projects/*/platforms/*/policies/*`.",
|
| 520 |
+
"location": "path",
|
| 521 |
+
"pattern": "^projects/[^/]+/platforms/[^/]+/policies/[^/]+$",
|
| 522 |
+
"required": true,
|
| 523 |
+
"type": "string"
|
| 524 |
+
}
|
| 525 |
+
},
|
| 526 |
+
"path": "v1/{+name}",
|
| 527 |
+
"response": {
|
| 528 |
+
"$ref": "Empty"
|
| 529 |
+
},
|
| 530 |
+
"scopes": [
|
| 531 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 532 |
+
]
|
| 533 |
+
},
|
| 534 |
+
"get": {
|
| 535 |
+
"description": "Gets a platform policy. Returns `NOT_FOUND` if the policy doesn't exist.",
|
| 536 |
+
"flatPath": "v1/projects/{projectsId}/platforms/{platformsId}/policies/{policiesId}",
|
| 537 |
+
"httpMethod": "GET",
|
| 538 |
+
"id": "binaryauthorization.projects.platforms.policies.get",
|
| 539 |
+
"parameterOrder": [
|
| 540 |
+
"name"
|
| 541 |
+
],
|
| 542 |
+
"parameters": {
|
| 543 |
+
"name": {
|
| 544 |
+
"description": "Required. The name of the platform policy to retrieve in the format `projects/*/platforms/*/policies/*`.",
|
| 545 |
+
"location": "path",
|
| 546 |
+
"pattern": "^projects/[^/]+/platforms/[^/]+/policies/[^/]+$",
|
| 547 |
+
"required": true,
|
| 548 |
+
"type": "string"
|
| 549 |
+
}
|
| 550 |
+
},
|
| 551 |
+
"path": "v1/{+name}",
|
| 552 |
+
"response": {
|
| 553 |
+
"$ref": "PlatformPolicy"
|
| 554 |
+
},
|
| 555 |
+
"scopes": [
|
| 556 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 557 |
+
]
|
| 558 |
+
},
|
| 559 |
+
"list": {
|
| 560 |
+
"description": "Lists platform policies owned by a project in the specified platform. Returns `INVALID_ARGUMENT` if the project or the platform doesn't exist.",
|
| 561 |
+
"flatPath": "v1/projects/{projectsId}/platforms/{platformsId}/policies",
|
| 562 |
+
"httpMethod": "GET",
|
| 563 |
+
"id": "binaryauthorization.projects.platforms.policies.list",
|
| 564 |
+
"parameterOrder": [
|
| 565 |
+
"parent"
|
| 566 |
+
],
|
| 567 |
+
"parameters": {
|
| 568 |
+
"pageSize": {
|
| 569 |
+
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server picks an appropriate default.",
|
| 570 |
+
"format": "int32",
|
| 571 |
+
"location": "query",
|
| 572 |
+
"type": "integer"
|
| 573 |
+
},
|
| 574 |
+
"pageToken": {
|
| 575 |
+
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListPlatformPoliciesResponse.next_page_token returned from the previous call to the `ListPlatformPolicies` method.",
|
| 576 |
+
"location": "query",
|
| 577 |
+
"type": "string"
|
| 578 |
+
},
|
| 579 |
+
"parent": {
|
| 580 |
+
"description": "Required. The resource name of the platform associated with the platform policies using the format `projects/*/platforms/*`.",
|
| 581 |
+
"location": "path",
|
| 582 |
+
"pattern": "^projects/[^/]+/platforms/[^/]+$",
|
| 583 |
+
"required": true,
|
| 584 |
+
"type": "string"
|
| 585 |
+
}
|
| 586 |
+
},
|
| 587 |
+
"path": "v1/{+parent}/policies",
|
| 588 |
+
"response": {
|
| 589 |
+
"$ref": "ListPlatformPoliciesResponse"
|
| 590 |
+
},
|
| 591 |
+
"scopes": [
|
| 592 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 593 |
+
]
|
| 594 |
+
},
|
| 595 |
+
"replacePlatformPolicy": {
|
| 596 |
+
"description": "Replaces a platform policy. Returns `NOT_FOUND` if the policy doesn't exist.",
|
| 597 |
+
"flatPath": "v1/projects/{projectsId}/platforms/{platformsId}/policies/{policiesId}",
|
| 598 |
+
"httpMethod": "PUT",
|
| 599 |
+
"id": "binaryauthorization.projects.platforms.policies.replacePlatformPolicy",
|
| 600 |
+
"parameterOrder": [
|
| 601 |
+
"name"
|
| 602 |
+
],
|
| 603 |
+
"parameters": {
|
| 604 |
+
"name": {
|
| 605 |
+
"description": "Output only. The relative resource name of the Binary Authorization platform policy, in the form of `projects/*/platforms/*/policies/*`.",
|
| 606 |
+
"location": "path",
|
| 607 |
+
"pattern": "^projects/[^/]+/platforms/[^/]+/policies/[^/]+$",
|
| 608 |
+
"required": true,
|
| 609 |
+
"type": "string"
|
| 610 |
+
}
|
| 611 |
+
},
|
| 612 |
+
"path": "v1/{+name}",
|
| 613 |
+
"request": {
|
| 614 |
+
"$ref": "PlatformPolicy"
|
| 615 |
+
},
|
| 616 |
+
"response": {
|
| 617 |
+
"$ref": "PlatformPolicy"
|
| 618 |
+
},
|
| 619 |
+
"scopes": [
|
| 620 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 621 |
+
]
|
| 622 |
+
}
|
| 623 |
+
}
|
| 624 |
+
}
|
| 625 |
+
}
|
| 626 |
+
},
|
| 627 |
+
"policy": {
|
| 628 |
+
"methods": {
|
| 629 |
+
"getIamPolicy": {
|
| 630 |
+
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
|
| 631 |
+
"flatPath": "v1/projects/{projectsId}/policy:getIamPolicy",
|
| 632 |
+
"httpMethod": "GET",
|
| 633 |
+
"id": "binaryauthorization.projects.policy.getIamPolicy",
|
| 634 |
+
"parameterOrder": [
|
| 635 |
+
"resource"
|
| 636 |
+
],
|
| 637 |
+
"parameters": {
|
| 638 |
+
"options.requestedPolicyVersion": {
|
| 639 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 640 |
+
"format": "int32",
|
| 641 |
+
"location": "query",
|
| 642 |
+
"type": "integer"
|
| 643 |
+
},
|
| 644 |
+
"resource": {
|
| 645 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 646 |
+
"location": "path",
|
| 647 |
+
"pattern": "^projects/[^/]+/policy$",
|
| 648 |
+
"required": true,
|
| 649 |
+
"type": "string"
|
| 650 |
+
}
|
| 651 |
+
},
|
| 652 |
+
"path": "v1/{+resource}:getIamPolicy",
|
| 653 |
+
"response": {
|
| 654 |
+
"$ref": "IamPolicy"
|
| 655 |
+
},
|
| 656 |
+
"scopes": [
|
| 657 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 658 |
+
]
|
| 659 |
+
},
|
| 660 |
+
"setIamPolicy": {
|
| 661 |
+
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
|
| 662 |
+
"flatPath": "v1/projects/{projectsId}/policy:setIamPolicy",
|
| 663 |
+
"httpMethod": "POST",
|
| 664 |
+
"id": "binaryauthorization.projects.policy.setIamPolicy",
|
| 665 |
+
"parameterOrder": [
|
| 666 |
+
"resource"
|
| 667 |
+
],
|
| 668 |
+
"parameters": {
|
| 669 |
+
"resource": {
|
| 670 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 671 |
+
"location": "path",
|
| 672 |
+
"pattern": "^projects/[^/]+/policy$",
|
| 673 |
+
"required": true,
|
| 674 |
+
"type": "string"
|
| 675 |
+
}
|
| 676 |
+
},
|
| 677 |
+
"path": "v1/{+resource}:setIamPolicy",
|
| 678 |
+
"request": {
|
| 679 |
+
"$ref": "SetIamPolicyRequest"
|
| 680 |
+
},
|
| 681 |
+
"response": {
|
| 682 |
+
"$ref": "IamPolicy"
|
| 683 |
+
},
|
| 684 |
+
"scopes": [
|
| 685 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 686 |
+
]
|
| 687 |
+
},
|
| 688 |
+
"testIamPermissions": {
|
| 689 |
+
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.",
|
| 690 |
+
"flatPath": "v1/projects/{projectsId}/policy:testIamPermissions",
|
| 691 |
+
"httpMethod": "POST",
|
| 692 |
+
"id": "binaryauthorization.projects.policy.testIamPermissions",
|
| 693 |
+
"parameterOrder": [
|
| 694 |
+
"resource"
|
| 695 |
+
],
|
| 696 |
+
"parameters": {
|
| 697 |
+
"resource": {
|
| 698 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 699 |
+
"location": "path",
|
| 700 |
+
"pattern": "^projects/[^/]+/policy$",
|
| 701 |
+
"required": true,
|
| 702 |
+
"type": "string"
|
| 703 |
+
}
|
| 704 |
+
},
|
| 705 |
+
"path": "v1/{+resource}:testIamPermissions",
|
| 706 |
+
"request": {
|
| 707 |
+
"$ref": "TestIamPermissionsRequest"
|
| 708 |
+
},
|
| 709 |
+
"response": {
|
| 710 |
+
"$ref": "TestIamPermissionsResponse"
|
| 711 |
+
},
|
| 712 |
+
"scopes": [
|
| 713 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 714 |
+
]
|
| 715 |
+
}
|
| 716 |
+
}
|
| 717 |
+
}
|
| 718 |
+
}
|
| 719 |
+
},
|
| 720 |
+
"systempolicy": {
|
| 721 |
+
"methods": {
|
| 722 |
+
"getPolicy": {
|
| 723 |
+
"description": "Gets the current system policy in the specified location.",
|
| 724 |
+
"flatPath": "v1/locations/{locationsId}/policy",
|
| 725 |
+
"httpMethod": "GET",
|
| 726 |
+
"id": "binaryauthorization.systempolicy.getPolicy",
|
| 727 |
+
"parameterOrder": [
|
| 728 |
+
"name"
|
| 729 |
+
],
|
| 730 |
+
"parameters": {
|
| 731 |
+
"name": {
|
| 732 |
+
"description": "Required. The resource name, in the format `locations/*/policy`. Note that the system policy is not associated with a project.",
|
| 733 |
+
"location": "path",
|
| 734 |
+
"pattern": "^locations/[^/]+/policy$",
|
| 735 |
+
"required": true,
|
| 736 |
+
"type": "string"
|
| 737 |
+
}
|
| 738 |
+
},
|
| 739 |
+
"path": "v1/{+name}",
|
| 740 |
+
"response": {
|
| 741 |
+
"$ref": "Policy"
|
| 742 |
+
},
|
| 743 |
+
"scopes": [
|
| 744 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 745 |
+
]
|
| 746 |
+
}
|
| 747 |
+
}
|
| 748 |
+
}
|
| 749 |
+
},
|
| 750 |
+
"revision": "20241115",
|
| 751 |
+
"rootUrl": "https://binaryauthorization.googleapis.com/",
|
| 752 |
+
"schemas": {
|
| 753 |
+
"AdmissionRule": {
|
| 754 |
+
"description": "An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation.",
|
| 755 |
+
"id": "AdmissionRule",
|
| 756 |
+
"properties": {
|
| 757 |
+
"enforcementMode": {
|
| 758 |
+
"description": "Required. The action when a pod creation is denied by the admission rule.",
|
| 759 |
+
"enum": [
|
| 760 |
+
"ENFORCEMENT_MODE_UNSPECIFIED",
|
| 761 |
+
"ENFORCED_BLOCK_AND_AUDIT_LOG",
|
| 762 |
+
"DRYRUN_AUDIT_LOG_ONLY"
|
| 763 |
+
],
|
| 764 |
+
"enumDescriptions": [
|
| 765 |
+
"Do not use.",
|
| 766 |
+
"Enforce the admission rule by blocking the pod creation.",
|
| 767 |
+
"Dryrun mode: Audit logging only. This will allow the pod creation as if the admission request had specified break-glass."
|
| 768 |
+
],
|
| 769 |
+
"type": "string"
|
| 770 |
+
},
|
| 771 |
+
"evaluationMode": {
|
| 772 |
+
"description": "Required. How this admission rule will be evaluated.",
|
| 773 |
+
"enum": [
|
| 774 |
+
"EVALUATION_MODE_UNSPECIFIED",
|
| 775 |
+
"ALWAYS_ALLOW",
|
| 776 |
+
"REQUIRE_ATTESTATION",
|
| 777 |
+
"ALWAYS_DENY"
|
| 778 |
+
],
|
| 779 |
+
"enumDescriptions": [
|
| 780 |
+
"Do not use.",
|
| 781 |
+
"This rule allows all pod creations.",
|
| 782 |
+
"This rule allows a pod creation if all the attestors listed in `require_attestations_by` have valid attestations for all of the images in the pod spec.",
|
| 783 |
+
"This rule denies all pod creations."
|
| 784 |
+
],
|
| 785 |
+
"type": "string"
|
| 786 |
+
},
|
| 787 |
+
"requireAttestationsBy": {
|
| 788 |
+
"items": {
|
| 789 |
+
"type": "string"
|
| 790 |
+
},
|
| 791 |
+
"type": "array"
|
| 792 |
+
}
|
| 793 |
+
},
|
| 794 |
+
"type": "object"
|
| 795 |
+
},
|
| 796 |
+
"AdmissionWhitelistPattern": {
|
| 797 |
+
"description": "An admission allowlist pattern exempts images from checks by admission rules.",
|
| 798 |
+
"id": "AdmissionWhitelistPattern",
|
| 799 |
+
"properties": {
|
| 800 |
+
"namePattern": {
|
| 801 |
+
"description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` wildcard, but this is allowed only in text after the `registry/` part. This also supports a trailing `**` wildcard which matches subdirectories of a given entry.",
|
| 802 |
+
"type": "string"
|
| 803 |
+
}
|
| 804 |
+
},
|
| 805 |
+
"type": "object"
|
| 806 |
+
},
|
| 807 |
+
"AllowlistResult": {
|
| 808 |
+
"description": "Result of evaluating an image name allowlist.",
|
| 809 |
+
"id": "AllowlistResult",
|
| 810 |
+
"properties": {
|
| 811 |
+
"matchedPattern": {
|
| 812 |
+
"description": "The allowlist pattern that the image matched.",
|
| 813 |
+
"type": "string"
|
| 814 |
+
}
|
| 815 |
+
},
|
| 816 |
+
"type": "object"
|
| 817 |
+
},
|
| 818 |
+
"AttestationAuthenticator": {
|
| 819 |
+
"description": "An attestation authenticator that will be used to verify attestations. Typically this is just a set of public keys. Conceptually, an authenticator can be treated as always returning either \"authenticated\" or \"not authenticated\" when presented with a signed attestation (almost always assumed to be a [DSSE](https://github.com/secure-systems-lab/dsse) attestation). The details of how an authenticator makes this decision are specific to the type of 'authenticator' that this message wraps.",
|
| 820 |
+
"id": "AttestationAuthenticator",
|
| 821 |
+
"properties": {
|
| 822 |
+
"displayName": {
|
| 823 |
+
"description": "Optional. A user-provided name for this `AttestationAuthenticator`. This field has no effect on the policy evaluation behavior except to improve readability of messages in evaluation results.",
|
| 824 |
+
"type": "string"
|
| 825 |
+
},
|
| 826 |
+
"pkixPublicKeySet": {
|
| 827 |
+
"$ref": "PkixPublicKeySet",
|
| 828 |
+
"description": "Optional. A set of raw PKIX SubjectPublicKeyInfo format public keys. If any public key in the set validates the attestation signature, then the signature is considered authenticated (i.e. any one key is sufficient to authenticate)."
|
| 829 |
+
}
|
| 830 |
+
},
|
| 831 |
+
"type": "object"
|
| 832 |
+
},
|
| 833 |
+
"AttestationOccurrence": {
|
| 834 |
+
"description": "Occurrence that represents a single \"attestation\". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign.",
|
| 835 |
+
"id": "AttestationOccurrence",
|
| 836 |
+
"properties": {
|
| 837 |
+
"jwts": {
|
| 838 |
+
"description": "One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.",
|
| 839 |
+
"items": {
|
| 840 |
+
"$ref": "Jwt"
|
| 841 |
+
},
|
| 842 |
+
"type": "array"
|
| 843 |
+
},
|
| 844 |
+
"serializedPayload": {
|
| 845 |
+
"description": "Required. The serialized payload that is verified by one or more `signatures`.",
|
| 846 |
+
"format": "byte",
|
| 847 |
+
"type": "string"
|
| 848 |
+
},
|
| 849 |
+
"signatures": {
|
| 850 |
+
"description": "One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.",
|
| 851 |
+
"items": {
|
| 852 |
+
"$ref": "Signature"
|
| 853 |
+
},
|
| 854 |
+
"type": "array"
|
| 855 |
+
}
|
| 856 |
+
},
|
| 857 |
+
"type": "object"
|
| 858 |
+
},
|
| 859 |
+
"AttestationSource": {
|
| 860 |
+
"description": "Specifies the locations for fetching the provenance attestations.",
|
| 861 |
+
"id": "AttestationSource",
|
| 862 |
+
"properties": {
|
| 863 |
+
"containerAnalysisAttestationProjects": {
|
| 864 |
+
"description": "The IDs of the Google Cloud projects that store the SLSA attestations as Container Analysis Occurrences, in the format `projects/[PROJECT_ID]`. Maximum number of `container_analysis_attestation_projects` allowed in each `AttestationSource` is 10.",
|
| 865 |
+
"items": {
|
| 866 |
+
"type": "string"
|
| 867 |
+
},
|
| 868 |
+
"type": "array"
|
| 869 |
+
}
|
| 870 |
+
},
|
| 871 |
+
"type": "object"
|
| 872 |
+
},
|
| 873 |
+
"Attestor": {
|
| 874 |
+
"description": "An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.",
|
| 875 |
+
"id": "Attestor",
|
| 876 |
+
"properties": {
|
| 877 |
+
"description": {
|
| 878 |
+
"description": "Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs.",
|
| 879 |
+
"type": "string"
|
| 880 |
+
},
|
| 881 |
+
"etag": {
|
| 882 |
+
"description": "Optional. A checksum, returned by the server, that can be sent on update requests to ensure the attestor has an up-to-date value before attempting to update it. See https://google.aip.dev/154.",
|
| 883 |
+
"type": "string"
|
| 884 |
+
},
|
| 885 |
+
"name": {
|
| 886 |
+
"description": "Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated.",
|
| 887 |
+
"type": "string"
|
| 888 |
+
},
|
| 889 |
+
"updateTime": {
|
| 890 |
+
"description": "Output only. Time when the attestor was last updated.",
|
| 891 |
+
"format": "google-datetime",
|
| 892 |
+
"readOnly": true,
|
| 893 |
+
"type": "string"
|
| 894 |
+
},
|
| 895 |
+
"userOwnedGrafeasNote": {
|
| 896 |
+
"$ref": "UserOwnedGrafeasNote",
|
| 897 |
+
"description": "This specifies how an attestation will be read, and how it will be used during policy enforcement."
|
| 898 |
+
}
|
| 899 |
+
},
|
| 900 |
+
"type": "object"
|
| 901 |
+
},
|
| 902 |
+
"AttestorPublicKey": {
|
| 903 |
+
"description": "An attestor public key that will be used to verify attestations signed by this attestor.",
|
| 904 |
+
"id": "AttestorPublicKey",
|
| 905 |
+
"properties": {
|
| 906 |
+
"asciiArmoredPgpPublicKey": {
|
| 907 |
+
"description": "ASCII-armored representation of a PGP public key, as the entire output by the command `gpg --export --armor foo@example.com` (either LF or CRLF line endings). When using this field, `id` should be left blank. The Binary Authorization API handlers will calculate the ID and fill it in automatically. Binary Authorization computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If `id` is provided by the caller, it will be overwritten by the API-calculated ID.",
|
| 908 |
+
"type": "string"
|
| 909 |
+
},
|
| 910 |
+
"comment": {
|
| 911 |
+
"description": "Optional. A descriptive comment. This field may be updated.",
|
| 912 |
+
"type": "string"
|
| 913 |
+
},
|
| 914 |
+
"id": {
|
| 915 |
+
"description": "The ID of this public key. Signatures verified by Binary Authorization must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on `public_key` cases below for details.",
|
| 916 |
+
"type": "string"
|
| 917 |
+
},
|
| 918 |
+
"pkixPublicKey": {
|
| 919 |
+
"$ref": "PkixPublicKey",
|
| 920 |
+
"description": "A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will be computed based on the digest of the DER encoding of the public key."
|
| 921 |
+
}
|
| 922 |
+
},
|
| 923 |
+
"type": "object"
|
| 924 |
+
},
|
| 925 |
+
"Binding": {
|
| 926 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 927 |
+
"id": "Binding",
|
| 928 |
+
"properties": {
|
| 929 |
+
"condition": {
|
| 930 |
+
"$ref": "Expr",
|
| 931 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 932 |
+
},
|
| 933 |
+
"members": {
|
| 934 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 935 |
+
"items": {
|
| 936 |
+
"type": "string"
|
| 937 |
+
},
|
| 938 |
+
"type": "array"
|
| 939 |
+
},
|
| 940 |
+
"role": {
|
| 941 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 942 |
+
"type": "string"
|
| 943 |
+
}
|
| 944 |
+
},
|
| 945 |
+
"type": "object"
|
| 946 |
+
},
|
| 947 |
+
"Check": {
|
| 948 |
+
"description": "A single check to perform against a Pod. Checks are grouped into `CheckSet` objects, which are defined by the top-level policy.",
|
| 949 |
+
"id": "Check",
|
| 950 |
+
"properties": {
|
| 951 |
+
"alwaysDeny": {
|
| 952 |
+
"description": "Optional. A special-case check that always denies. Note that this still only applies when the scope of the `CheckSet` applies and the image isn't exempted by an image allowlist. This check is primarily useful for testing, or to set the default behavior for all unmatched scopes to \"deny\".",
|
| 953 |
+
"type": "boolean"
|
| 954 |
+
},
|
| 955 |
+
"displayName": {
|
| 956 |
+
"description": "Optional. A user-provided name for this check. This field has no effect on the policy evaluation behavior except to improve readability of messages in evaluation results.",
|
| 957 |
+
"type": "string"
|
| 958 |
+
},
|
| 959 |
+
"imageAllowlist": {
|
| 960 |
+
"$ref": "ImageAllowlist",
|
| 961 |
+
"description": "Optional. Images exempted from this check. If any of the patterns match the image url, the check will not be evaluated."
|
| 962 |
+
},
|
| 963 |
+
"imageFreshnessCheck": {
|
| 964 |
+
"$ref": "ImageFreshnessCheck",
|
| 965 |
+
"description": "Optional. Require that an image is no older than a configured expiration time. Image age is determined by its upload time."
|
| 966 |
+
},
|
| 967 |
+
"sigstoreSignatureCheck": {
|
| 968 |
+
"$ref": "SigstoreSignatureCheck",
|
| 969 |
+
"description": "Optional. Require that an image was signed by Cosign with a trusted key. This check requires that both the image and signature are stored in Artifact Registry."
|
| 970 |
+
},
|
| 971 |
+
"simpleSigningAttestationCheck": {
|
| 972 |
+
"$ref": "SimpleSigningAttestationCheck",
|
| 973 |
+
"description": "Optional. Require a SimpleSigning-type attestation for every image in the deployment."
|
| 974 |
+
},
|
| 975 |
+
"slsaCheck": {
|
| 976 |
+
"$ref": "SlsaCheck",
|
| 977 |
+
"description": "Optional. Require that an image was built by a trusted builder (such as Google Cloud Build), meets requirements for Supply chain Levels for Software Artifacts (SLSA), and was built from a trusted source code repostitory."
|
| 978 |
+
},
|
| 979 |
+
"trustedDirectoryCheck": {
|
| 980 |
+
"$ref": "TrustedDirectoryCheck",
|
| 981 |
+
"description": "Optional. Require that an image lives in a trusted directory."
|
| 982 |
+
},
|
| 983 |
+
"vulnerabilityCheck": {
|
| 984 |
+
"$ref": "VulnerabilityCheck",
|
| 985 |
+
"description": "Optional. Require that an image does not contain vulnerabilities that violate the configured rules, such as based on severity levels."
|
| 986 |
+
}
|
| 987 |
+
},
|
| 988 |
+
"type": "object"
|
| 989 |
+
},
|
| 990 |
+
"CheckResult": {
|
| 991 |
+
"description": "Result of evaluating one check.",
|
| 992 |
+
"id": "CheckResult",
|
| 993 |
+
"properties": {
|
| 994 |
+
"allowlistResult": {
|
| 995 |
+
"$ref": "AllowlistResult",
|
| 996 |
+
"description": "If the image was exempted by an allow_pattern in the check, contains the pattern that the image name matched."
|
| 997 |
+
},
|
| 998 |
+
"displayName": {
|
| 999 |
+
"description": "The name of the check.",
|
| 1000 |
+
"type": "string"
|
| 1001 |
+
},
|
| 1002 |
+
"evaluationResult": {
|
| 1003 |
+
"$ref": "EvaluationResult",
|
| 1004 |
+
"description": "If a check was evaluated, contains the result of the check."
|
| 1005 |
+
},
|
| 1006 |
+
"explanation": {
|
| 1007 |
+
"description": "Explanation of this check result.",
|
| 1008 |
+
"type": "string"
|
| 1009 |
+
},
|
| 1010 |
+
"index": {
|
| 1011 |
+
"description": "The index of the check.",
|
| 1012 |
+
"format": "int64",
|
| 1013 |
+
"type": "string"
|
| 1014 |
+
},
|
| 1015 |
+
"type": {
|
| 1016 |
+
"description": "The type of the check.",
|
| 1017 |
+
"type": "string"
|
| 1018 |
+
}
|
| 1019 |
+
},
|
| 1020 |
+
"type": "object"
|
| 1021 |
+
},
|
| 1022 |
+
"CheckResults": {
|
| 1023 |
+
"description": "Result of evaluating one or more checks.",
|
| 1024 |
+
"id": "CheckResults",
|
| 1025 |
+
"properties": {
|
| 1026 |
+
"results": {
|
| 1027 |
+
"description": "Per-check details.",
|
| 1028 |
+
"items": {
|
| 1029 |
+
"$ref": "CheckResult"
|
| 1030 |
+
},
|
| 1031 |
+
"type": "array"
|
| 1032 |
+
}
|
| 1033 |
+
},
|
| 1034 |
+
"type": "object"
|
| 1035 |
+
},
|
| 1036 |
+
"CheckSet": {
|
| 1037 |
+
"description": "A conjunction of policy checks, scoped to a particular namespace or Kubernetes service account. In order for evaluation of a `CheckSet` to return \"allowed\" for a given image in a given Pod, one of the following conditions must be satisfied: * The image is explicitly exempted by an entry in `image_allowlist`, OR * ALL of the `checks` evaluate to \"allowed\".",
|
| 1038 |
+
"id": "CheckSet",
|
| 1039 |
+
"properties": {
|
| 1040 |
+
"checks": {
|
| 1041 |
+
"description": "Optional. The checks to apply. The ultimate result of evaluating the check set will be \"allow\" if and only if every check in `checks` evaluates to \"allow\". If `checks` is empty, the default behavior is \"always allow\".",
|
| 1042 |
+
"items": {
|
| 1043 |
+
"$ref": "Check"
|
| 1044 |
+
},
|
| 1045 |
+
"type": "array"
|
| 1046 |
+
},
|
| 1047 |
+
"displayName": {
|
| 1048 |
+
"description": "Optional. A user-provided name for this `CheckSet`. This field has no effect on the policy evaluation behavior except to improve readability of messages in evaluation results.",
|
| 1049 |
+
"type": "string"
|
| 1050 |
+
},
|
| 1051 |
+
"imageAllowlist": {
|
| 1052 |
+
"$ref": "ImageAllowlist",
|
| 1053 |
+
"description": "Optional. Images exempted from this `CheckSet`. If any of the patterns match the image being evaluated, no checks in the `CheckSet` will be evaluated."
|
| 1054 |
+
},
|
| 1055 |
+
"scope": {
|
| 1056 |
+
"$ref": "Scope",
|
| 1057 |
+
"description": "Optional. The scope to which this `CheckSet` applies. If unset or an empty string (the default), applies to all namespaces and service accounts. See the `Scope` message documentation for details on scoping rules."
|
| 1058 |
+
}
|
| 1059 |
+
},
|
| 1060 |
+
"type": "object"
|
| 1061 |
+
},
|
| 1062 |
+
"CheckSetResult": {
|
| 1063 |
+
"description": "Result of evaluating one check set.",
|
| 1064 |
+
"id": "CheckSetResult",
|
| 1065 |
+
"properties": {
|
| 1066 |
+
"allowlistResult": {
|
| 1067 |
+
"$ref": "AllowlistResult",
|
| 1068 |
+
"description": "If the image was exempted by an allow_pattern in the check set, contains the pattern that the image name matched."
|
| 1069 |
+
},
|
| 1070 |
+
"checkResults": {
|
| 1071 |
+
"$ref": "CheckResults",
|
| 1072 |
+
"description": "If checks were evaluated, contains the results of evaluating each check."
|
| 1073 |
+
},
|
| 1074 |
+
"displayName": {
|
| 1075 |
+
"description": "The name of the check set.",
|
| 1076 |
+
"type": "string"
|
| 1077 |
+
},
|
| 1078 |
+
"explanation": {
|
| 1079 |
+
"description": "Explanation of this check set result. Only populated if no checks were evaluated.",
|
| 1080 |
+
"type": "string"
|
| 1081 |
+
},
|
| 1082 |
+
"index": {
|
| 1083 |
+
"description": "The index of the check set.",
|
| 1084 |
+
"format": "int64",
|
| 1085 |
+
"type": "string"
|
| 1086 |
+
},
|
| 1087 |
+
"scope": {
|
| 1088 |
+
"$ref": "Scope",
|
| 1089 |
+
"description": "The scope of the check set."
|
| 1090 |
+
}
|
| 1091 |
+
},
|
| 1092 |
+
"type": "object"
|
| 1093 |
+
},
|
| 1094 |
+
"Empty": {
|
| 1095 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 1096 |
+
"id": "Empty",
|
| 1097 |
+
"properties": {},
|
| 1098 |
+
"type": "object"
|
| 1099 |
+
},
|
| 1100 |
+
"EvaluateGkePolicyRequest": {
|
| 1101 |
+
"description": "Request message for PlatformPolicyEvaluationService.EvaluateGkePolicy.",
|
| 1102 |
+
"id": "EvaluateGkePolicyRequest",
|
| 1103 |
+
"properties": {
|
| 1104 |
+
"resource": {
|
| 1105 |
+
"additionalProperties": {
|
| 1106 |
+
"description": "Properties of the object.",
|
| 1107 |
+
"type": "any"
|
| 1108 |
+
},
|
| 1109 |
+
"description": "Required. JSON or YAML blob representing a Kubernetes resource.",
|
| 1110 |
+
"type": "object"
|
| 1111 |
+
}
|
| 1112 |
+
},
|
| 1113 |
+
"type": "object"
|
| 1114 |
+
},
|
| 1115 |
+
"EvaluateGkePolicyResponse": {
|
| 1116 |
+
"description": "Response message for PlatformPolicyEvaluationService.EvaluateGkePolicy.",
|
| 1117 |
+
"id": "EvaluateGkePolicyResponse",
|
| 1118 |
+
"properties": {
|
| 1119 |
+
"results": {
|
| 1120 |
+
"description": "Evaluation result for each Pod contained in the request.",
|
| 1121 |
+
"items": {
|
| 1122 |
+
"$ref": "PodResult"
|
| 1123 |
+
},
|
| 1124 |
+
"type": "array"
|
| 1125 |
+
},
|
| 1126 |
+
"verdict": {
|
| 1127 |
+
"description": "The result of evaluating all Pods in the request.",
|
| 1128 |
+
"enum": [
|
| 1129 |
+
"VERDICT_UNSPECIFIED",
|
| 1130 |
+
"CONFORMANT",
|
| 1131 |
+
"NON_CONFORMANT",
|
| 1132 |
+
"ERROR"
|
| 1133 |
+
],
|
| 1134 |
+
"enumDescriptions": [
|
| 1135 |
+
"Not specified. This should never be used.",
|
| 1136 |
+
"All Pods in the request conform to the policy.",
|
| 1137 |
+
"At least one Pod does not conform to the policy.",
|
| 1138 |
+
"Encountered at least one error evaluating a Pod and all other Pods conform to the policy. Non-conformance has precedence over errors."
|
| 1139 |
+
],
|
| 1140 |
+
"type": "string"
|
| 1141 |
+
}
|
| 1142 |
+
},
|
| 1143 |
+
"type": "object"
|
| 1144 |
+
},
|
| 1145 |
+
"EvaluationResult": {
|
| 1146 |
+
"description": "Result of evaluating one check.",
|
| 1147 |
+
"id": "EvaluationResult",
|
| 1148 |
+
"properties": {
|
| 1149 |
+
"verdict": {
|
| 1150 |
+
"description": "The result of evaluating this check.",
|
| 1151 |
+
"enum": [
|
| 1152 |
+
"CHECK_VERDICT_UNSPECIFIED",
|
| 1153 |
+
"CONFORMANT",
|
| 1154 |
+
"NON_CONFORMANT",
|
| 1155 |
+
"ERROR"
|
| 1156 |
+
],
|
| 1157 |
+
"enumDescriptions": [
|
| 1158 |
+
"Not specified. This should never be used.",
|
| 1159 |
+
"The check was successfully evaluated and the image satisfied the check.",
|
| 1160 |
+
"The check was successfully evaluated and the image did not satisfy the check.",
|
| 1161 |
+
"The check was not successfully evaluated."
|
| 1162 |
+
],
|
| 1163 |
+
"type": "string"
|
| 1164 |
+
}
|
| 1165 |
+
},
|
| 1166 |
+
"type": "object"
|
| 1167 |
+
},
|
| 1168 |
+
"Expr": {
|
| 1169 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 1170 |
+
"id": "Expr",
|
| 1171 |
+
"properties": {
|
| 1172 |
+
"description": {
|
| 1173 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 1174 |
+
"type": "string"
|
| 1175 |
+
},
|
| 1176 |
+
"expression": {
|
| 1177 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 1178 |
+
"type": "string"
|
| 1179 |
+
},
|
| 1180 |
+
"location": {
|
| 1181 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 1182 |
+
"type": "string"
|
| 1183 |
+
},
|
| 1184 |
+
"title": {
|
| 1185 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 1186 |
+
"type": "string"
|
| 1187 |
+
}
|
| 1188 |
+
},
|
| 1189 |
+
"type": "object"
|
| 1190 |
+
},
|
| 1191 |
+
"GkePolicy": {
|
| 1192 |
+
"description": "A Binary Authorization policy for a GKE cluster. This is one type of policy that can occur as a `PlatformPolicy`.",
|
| 1193 |
+
"id": "GkePolicy",
|
| 1194 |
+
"properties": {
|
| 1195 |
+
"checkSets": {
|
| 1196 |
+
"description": "Optional. The `CheckSet` objects to apply, scoped by namespace or namespace and service account. Exactly one `CheckSet` will be evaluated for a given Pod (unless the list is empty, in which case the behavior is \"always allow\"). If multiple `CheckSet` objects have scopes that match the namespace and service account of the Pod being evaluated, only the `CheckSet` with the MOST SPECIFIC scope will match. `CheckSet` objects must be listed in order of decreasing specificity, i.e. if a scope matches a given service account (which must include the namespace), it must come before a `CheckSet` with a scope matching just that namespace. This property is enforced by server-side validation. The purpose of this restriction is to ensure that if more than one `CheckSet` matches a given Pod, the `CheckSet` that will be evaluated will always be the first in the list to match (because if any other matches, it must be less specific). If `check_sets` is empty, the default behavior is to allow all images. If `check_sets` is non-empty, the last `check_sets` entry must always be a `CheckSet` with no scope set, i.e. a catchall to handle any situation not caught by the preceding `CheckSet` objects.",
|
| 1197 |
+
"items": {
|
| 1198 |
+
"$ref": "CheckSet"
|
| 1199 |
+
},
|
| 1200 |
+
"type": "array"
|
| 1201 |
+
},
|
| 1202 |
+
"imageAllowlist": {
|
| 1203 |
+
"$ref": "ImageAllowlist",
|
| 1204 |
+
"description": "Optional. Images exempted from this policy. If any of the patterns match the image being evaluated, the rest of the policy will not be evaluated."
|
| 1205 |
+
}
|
| 1206 |
+
},
|
| 1207 |
+
"type": "object"
|
| 1208 |
+
},
|
| 1209 |
+
"IamPolicy": {
|
| 1210 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 1211 |
+
"id": "IamPolicy",
|
| 1212 |
+
"properties": {
|
| 1213 |
+
"bindings": {
|
| 1214 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 1215 |
+
"items": {
|
| 1216 |
+
"$ref": "Binding"
|
| 1217 |
+
},
|
| 1218 |
+
"type": "array"
|
| 1219 |
+
},
|
| 1220 |
+
"etag": {
|
| 1221 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 1222 |
+
"format": "byte",
|
| 1223 |
+
"type": "string"
|
| 1224 |
+
},
|
| 1225 |
+
"version": {
|
| 1226 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 1227 |
+
"format": "int32",
|
| 1228 |
+
"type": "integer"
|
| 1229 |
+
}
|
| 1230 |
+
},
|
| 1231 |
+
"type": "object"
|
| 1232 |
+
},
|
| 1233 |
+
"ImageAllowlist": {
|
| 1234 |
+
"description": "Images that are exempted from normal checks based on name pattern only.",
|
| 1235 |
+
"id": "ImageAllowlist",
|
| 1236 |
+
"properties": {
|
| 1237 |
+
"allowPattern": {
|
| 1238 |
+
"description": "Required. A disjunction of image patterns to allow. If any of these patterns match, then the image is considered exempted by this allowlist.",
|
| 1239 |
+
"items": {
|
| 1240 |
+
"type": "string"
|
| 1241 |
+
},
|
| 1242 |
+
"type": "array"
|
| 1243 |
+
}
|
| 1244 |
+
},
|
| 1245 |
+
"type": "object"
|
| 1246 |
+
},
|
| 1247 |
+
"ImageFreshnessCheck": {
|
| 1248 |
+
"description": "An image freshness check, which rejects images that were uploaded before the set number of days ago to the supported repositories.",
|
| 1249 |
+
"id": "ImageFreshnessCheck",
|
| 1250 |
+
"properties": {
|
| 1251 |
+
"maxUploadAgeDays": {
|
| 1252 |
+
"description": "Required. The max number of days that is allowed since the image was uploaded. Must be greater than zero.",
|
| 1253 |
+
"format": "int32",
|
| 1254 |
+
"type": "integer"
|
| 1255 |
+
}
|
| 1256 |
+
},
|
| 1257 |
+
"type": "object"
|
| 1258 |
+
},
|
| 1259 |
+
"ImageResult": {
|
| 1260 |
+
"description": "Result of evaluating one image.",
|
| 1261 |
+
"id": "ImageResult",
|
| 1262 |
+
"properties": {
|
| 1263 |
+
"allowlistResult": {
|
| 1264 |
+
"$ref": "AllowlistResult",
|
| 1265 |
+
"description": "If the image was exempted by a top-level allow_pattern, contains the allowlist pattern that the image name matched."
|
| 1266 |
+
},
|
| 1267 |
+
"checkSetResult": {
|
| 1268 |
+
"$ref": "CheckSetResult",
|
| 1269 |
+
"description": "If a check set was evaluated, contains the result of the check set. Empty if there were no check sets."
|
| 1270 |
+
},
|
| 1271 |
+
"explanation": {
|
| 1272 |
+
"description": "Explanation of this image result. Only populated if no check sets were evaluated.",
|
| 1273 |
+
"type": "string"
|
| 1274 |
+
},
|
| 1275 |
+
"imageUri": {
|
| 1276 |
+
"description": "Image URI from the request.",
|
| 1277 |
+
"type": "string"
|
| 1278 |
+
},
|
| 1279 |
+
"verdict": {
|
| 1280 |
+
"description": "The result of evaluating this image.",
|
| 1281 |
+
"enum": [
|
| 1282 |
+
"IMAGE_VERDICT_UNSPECIFIED",
|
| 1283 |
+
"CONFORMANT",
|
| 1284 |
+
"NON_CONFORMANT",
|
| 1285 |
+
"ERROR"
|
| 1286 |
+
],
|
| 1287 |
+
"enumDescriptions": [
|
| 1288 |
+
"Not specified. This should never be used.",
|
| 1289 |
+
"Image conforms to the policy.",
|
| 1290 |
+
"Image does not conform to the policy.",
|
| 1291 |
+
"Error evaluating the image. Non-conformance has precedence over errors."
|
| 1292 |
+
],
|
| 1293 |
+
"type": "string"
|
| 1294 |
+
}
|
| 1295 |
+
},
|
| 1296 |
+
"type": "object"
|
| 1297 |
+
},
|
| 1298 |
+
"Jwt": {
|
| 1299 |
+
"id": "Jwt",
|
| 1300 |
+
"properties": {
|
| 1301 |
+
"compactJwt": {
|
| 1302 |
+
"description": "The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1",
|
| 1303 |
+
"type": "string"
|
| 1304 |
+
}
|
| 1305 |
+
},
|
| 1306 |
+
"type": "object"
|
| 1307 |
+
},
|
| 1308 |
+
"ListAttestorsResponse": {
|
| 1309 |
+
"description": "Response message for BinauthzManagementServiceV1.ListAttestors.",
|
| 1310 |
+
"id": "ListAttestorsResponse",
|
| 1311 |
+
"properties": {
|
| 1312 |
+
"attestors": {
|
| 1313 |
+
"description": "The list of attestors.",
|
| 1314 |
+
"items": {
|
| 1315 |
+
"$ref": "Attestor"
|
| 1316 |
+
},
|
| 1317 |
+
"type": "array"
|
| 1318 |
+
},
|
| 1319 |
+
"nextPageToken": {
|
| 1320 |
+
"description": "A token to retrieve the next page of results. Pass this value in the ListAttestorsRequest.page_token field in the subsequent call to the `ListAttestors` method to retrieve the next page of results.",
|
| 1321 |
+
"type": "string"
|
| 1322 |
+
}
|
| 1323 |
+
},
|
| 1324 |
+
"type": "object"
|
| 1325 |
+
},
|
| 1326 |
+
"ListPlatformPoliciesResponse": {
|
| 1327 |
+
"description": "Response message for PlatformPolicyManagementService.ListPlatformPolicies.",
|
| 1328 |
+
"id": "ListPlatformPoliciesResponse",
|
| 1329 |
+
"properties": {
|
| 1330 |
+
"nextPageToken": {
|
| 1331 |
+
"description": "A token to retrieve the next page of results. Pass this value in the ListPlatformPoliciesRequest.page_token field in the subsequent call to the `ListPlatformPolicies` method to retrieve the next page of results.",
|
| 1332 |
+
"type": "string"
|
| 1333 |
+
},
|
| 1334 |
+
"platformPolicies": {
|
| 1335 |
+
"description": "The list of platform policies.",
|
| 1336 |
+
"items": {
|
| 1337 |
+
"$ref": "PlatformPolicy"
|
| 1338 |
+
},
|
| 1339 |
+
"type": "array"
|
| 1340 |
+
}
|
| 1341 |
+
},
|
| 1342 |
+
"type": "object"
|
| 1343 |
+
},
|
| 1344 |
+
"PkixPublicKey": {
|
| 1345 |
+
"description": "A public key in the PkixPublicKey [format](https://tools.ietf.org/html/rfc5280#section-4.1.2.7). Public keys of this type are typically textually encoded using the PEM format.",
|
| 1346 |
+
"id": "PkixPublicKey",
|
| 1347 |
+
"properties": {
|
| 1348 |
+
"keyId": {
|
| 1349 |
+
"description": "Optional. The ID of this public key. Signatures verified by Binary Authorization must include the ID of the public key that can be used to verify them. The ID must match exactly contents of the `key_id` field exactly. The ID may be explicitly provided by the caller, but it MUST be a valid RFC3986 URI. If `key_id` is left blank and this `PkixPublicKey` is not used in the context of a wrapper (see next paragraph), a default key ID will be computed based on the digest of the DER encoding of the public key. If this `PkixPublicKey` is used in the context of a wrapper that has its own notion of key ID (e.g. `AttestorPublicKey`), then this field can either match that value exactly, or be left blank, in which case it behaves exactly as though it is equal to that wrapper value.",
|
| 1350 |
+
"type": "string"
|
| 1351 |
+
},
|
| 1352 |
+
"publicKeyPem": {
|
| 1353 |
+
"description": "A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13",
|
| 1354 |
+
"type": "string"
|
| 1355 |
+
},
|
| 1356 |
+
"signatureAlgorithm": {
|
| 1357 |
+
"description": "The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in `public_key_pem` (i.e. this algorithm must match that of the public key).",
|
| 1358 |
+
"enum": [
|
| 1359 |
+
"SIGNATURE_ALGORITHM_UNSPECIFIED",
|
| 1360 |
+
"RSA_PSS_2048_SHA256",
|
| 1361 |
+
"RSA_SIGN_PSS_2048_SHA256",
|
| 1362 |
+
"RSA_PSS_3072_SHA256",
|
| 1363 |
+
"RSA_SIGN_PSS_3072_SHA256",
|
| 1364 |
+
"RSA_PSS_4096_SHA256",
|
| 1365 |
+
"RSA_SIGN_PSS_4096_SHA256",
|
| 1366 |
+
"RSA_PSS_4096_SHA512",
|
| 1367 |
+
"RSA_SIGN_PSS_4096_SHA512",
|
| 1368 |
+
"RSA_SIGN_PKCS1_2048_SHA256",
|
| 1369 |
+
"RSA_SIGN_PKCS1_3072_SHA256",
|
| 1370 |
+
"RSA_SIGN_PKCS1_4096_SHA256",
|
| 1371 |
+
"RSA_SIGN_PKCS1_4096_SHA512",
|
| 1372 |
+
"ECDSA_P256_SHA256",
|
| 1373 |
+
"EC_SIGN_P256_SHA256",
|
| 1374 |
+
"ECDSA_P384_SHA384",
|
| 1375 |
+
"EC_SIGN_P384_SHA384",
|
| 1376 |
+
"ECDSA_P521_SHA512",
|
| 1377 |
+
"EC_SIGN_P521_SHA512"
|
| 1378 |
+
],
|
| 1379 |
+
"enumDescriptions": [
|
| 1380 |
+
"Not specified.",
|
| 1381 |
+
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
|
| 1382 |
+
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
|
| 1383 |
+
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
|
| 1384 |
+
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
|
| 1385 |
+
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
|
| 1386 |
+
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
|
| 1387 |
+
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
|
| 1388 |
+
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
|
| 1389 |
+
"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.",
|
| 1390 |
+
"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.",
|
| 1391 |
+
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.",
|
| 1392 |
+
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.",
|
| 1393 |
+
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
| 1394 |
+
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
| 1395 |
+
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
| 1396 |
+
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
| 1397 |
+
"ECDSA on the NIST P-521 curve with a SHA512 digest.",
|
| 1398 |
+
"ECDSA on the NIST P-521 curve with a SHA512 digest."
|
| 1399 |
+
],
|
| 1400 |
+
"type": "string"
|
| 1401 |
+
}
|
| 1402 |
+
},
|
| 1403 |
+
"type": "object"
|
| 1404 |
+
},
|
| 1405 |
+
"PkixPublicKeySet": {
|
| 1406 |
+
"description": "A bundle of PKIX public keys, used to authenticate attestation signatures. Generally, a signature is considered to be authenticated by a `PkixPublicKeySet` if any of the public keys verify it (i.e. it is an \"OR\" of the keys).",
|
| 1407 |
+
"id": "PkixPublicKeySet",
|
| 1408 |
+
"properties": {
|
| 1409 |
+
"pkixPublicKeys": {
|
| 1410 |
+
"description": "Required. `pkix_public_keys` must have at least one entry.",
|
| 1411 |
+
"items": {
|
| 1412 |
+
"$ref": "PkixPublicKey"
|
| 1413 |
+
},
|
| 1414 |
+
"type": "array"
|
| 1415 |
+
}
|
| 1416 |
+
},
|
| 1417 |
+
"type": "object"
|
| 1418 |
+
},
|
| 1419 |
+
"PlatformPolicy": {
|
| 1420 |
+
"description": "A Binary Authorization platform policy for deployments on various platforms.",
|
| 1421 |
+
"id": "PlatformPolicy",
|
| 1422 |
+
"properties": {
|
| 1423 |
+
"description": {
|
| 1424 |
+
"description": "Optional. A description comment about the policy.",
|
| 1425 |
+
"type": "string"
|
| 1426 |
+
},
|
| 1427 |
+
"etag": {
|
| 1428 |
+
"description": "Optional. Used to prevent updating the policy when another request has updated it since it was retrieved.",
|
| 1429 |
+
"type": "string"
|
| 1430 |
+
},
|
| 1431 |
+
"gkePolicy": {
|
| 1432 |
+
"$ref": "GkePolicy",
|
| 1433 |
+
"description": "Optional. GKE platform-specific policy."
|
| 1434 |
+
},
|
| 1435 |
+
"name": {
|
| 1436 |
+
"description": "Output only. The relative resource name of the Binary Authorization platform policy, in the form of `projects/*/platforms/*/policies/*`.",
|
| 1437 |
+
"readOnly": true,
|
| 1438 |
+
"type": "string"
|
| 1439 |
+
},
|
| 1440 |
+
"updateTime": {
|
| 1441 |
+
"description": "Output only. Time when the policy was last updated.",
|
| 1442 |
+
"format": "google-datetime",
|
| 1443 |
+
"readOnly": true,
|
| 1444 |
+
"type": "string"
|
| 1445 |
+
}
|
| 1446 |
+
},
|
| 1447 |
+
"type": "object"
|
| 1448 |
+
},
|
| 1449 |
+
"PodResult": {
|
| 1450 |
+
"description": "Result of evaluating the whole GKE policy for one Pod.",
|
| 1451 |
+
"id": "PodResult",
|
| 1452 |
+
"properties": {
|
| 1453 |
+
"imageResults": {
|
| 1454 |
+
"description": "Per-image details.",
|
| 1455 |
+
"items": {
|
| 1456 |
+
"$ref": "ImageResult"
|
| 1457 |
+
},
|
| 1458 |
+
"type": "array"
|
| 1459 |
+
},
|
| 1460 |
+
"kubernetesNamespace": {
|
| 1461 |
+
"description": "The Kubernetes namespace of the Pod.",
|
| 1462 |
+
"type": "string"
|
| 1463 |
+
},
|
| 1464 |
+
"kubernetesServiceAccount": {
|
| 1465 |
+
"description": "The Kubernetes service account of the Pod.",
|
| 1466 |
+
"type": "string"
|
| 1467 |
+
},
|
| 1468 |
+
"podName": {
|
| 1469 |
+
"description": "The name of the Pod.",
|
| 1470 |
+
"type": "string"
|
| 1471 |
+
},
|
| 1472 |
+
"verdict": {
|
| 1473 |
+
"description": "The result of evaluating this Pod.",
|
| 1474 |
+
"enum": [
|
| 1475 |
+
"POD_VERDICT_UNSPECIFIED",
|
| 1476 |
+
"CONFORMANT",
|
| 1477 |
+
"NON_CONFORMANT",
|
| 1478 |
+
"ERROR"
|
| 1479 |
+
],
|
| 1480 |
+
"enumDescriptions": [
|
| 1481 |
+
"Not specified. This should never be used.",
|
| 1482 |
+
"All images conform to the policy.",
|
| 1483 |
+
"At least one image does not conform to the policy.",
|
| 1484 |
+
"Encountered at least one error evaluating an image and all other images with non-error verdicts conform to the policy. Non-conformance has precedence over errors."
|
| 1485 |
+
],
|
| 1486 |
+
"type": "string"
|
| 1487 |
+
}
|
| 1488 |
+
},
|
| 1489 |
+
"type": "object"
|
| 1490 |
+
},
|
| 1491 |
+
"Policy": {
|
| 1492 |
+
"description": "A policy for container image binary authorization.",
|
| 1493 |
+
"id": "Policy",
|
| 1494 |
+
"properties": {
|
| 1495 |
+
"admissionWhitelistPatterns": {
|
| 1496 |
+
"description": "Optional. Admission policy allowlisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies.",
|
| 1497 |
+
"items": {
|
| 1498 |
+
"$ref": "AdmissionWhitelistPattern"
|
| 1499 |
+
},
|
| 1500 |
+
"type": "array"
|
| 1501 |
+
},
|
| 1502 |
+
"clusterAdmissionRules": {
|
| 1503 |
+
"additionalProperties": {
|
| 1504 |
+
"$ref": "AdmissionRule"
|
| 1505 |
+
},
|
| 1506 |
+
"description": "Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.",
|
| 1507 |
+
"type": "object"
|
| 1508 |
+
},
|
| 1509 |
+
"defaultAdmissionRule": {
|
| 1510 |
+
"$ref": "AdmissionRule",
|
| 1511 |
+
"description": "Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule."
|
| 1512 |
+
},
|
| 1513 |
+
"description": {
|
| 1514 |
+
"description": "Optional. A descriptive comment.",
|
| 1515 |
+
"type": "string"
|
| 1516 |
+
},
|
| 1517 |
+
"etag": {
|
| 1518 |
+
"description": "Optional. A checksum, returned by the server, that can be sent on update requests to ensure the policy has an up-to-date value before attempting to update it. See https://google.aip.dev/154.",
|
| 1519 |
+
"type": "string"
|
| 1520 |
+
},
|
| 1521 |
+
"globalPolicyEvaluationMode": {
|
| 1522 |
+
"description": "Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy.",
|
| 1523 |
+
"enum": [
|
| 1524 |
+
"GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED",
|
| 1525 |
+
"ENABLE",
|
| 1526 |
+
"DISABLE"
|
| 1527 |
+
],
|
| 1528 |
+
"enumDescriptions": [
|
| 1529 |
+
"Not specified: `DISABLE` is assumed.",
|
| 1530 |
+
"Enables system policy evaluation.",
|
| 1531 |
+
"Disables system policy evaluation."
|
| 1532 |
+
],
|
| 1533 |
+
"type": "string"
|
| 1534 |
+
},
|
| 1535 |
+
"istioServiceIdentityAdmissionRules": {
|
| 1536 |
+
"additionalProperties": {
|
| 1537 |
+
"$ref": "AdmissionRule"
|
| 1538 |
+
},
|
| 1539 |
+
"description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: `spiffe:///ns//sa/` or `/ns//sa/` e.g. `spiffe://example.com/ns/test-ns/sa/default`",
|
| 1540 |
+
"type": "object"
|
| 1541 |
+
},
|
| 1542 |
+
"kubernetesNamespaceAdmissionRules": {
|
| 1543 |
+
"additionalProperties": {
|
| 1544 |
+
"$ref": "AdmissionRule"
|
| 1545 |
+
},
|
| 1546 |
+
"description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: `[a-z.-]+`, e.g. `some-namespace`",
|
| 1547 |
+
"type": "object"
|
| 1548 |
+
},
|
| 1549 |
+
"kubernetesServiceAccountAdmissionRules": {
|
| 1550 |
+
"additionalProperties": {
|
| 1551 |
+
"$ref": "AdmissionRule"
|
| 1552 |
+
},
|
| 1553 |
+
"description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns:default`",
|
| 1554 |
+
"type": "object"
|
| 1555 |
+
},
|
| 1556 |
+
"name": {
|
| 1557 |
+
"description": "Output only. The resource name, in the format `projects/*/policy`. There is at most one policy per project.",
|
| 1558 |
+
"readOnly": true,
|
| 1559 |
+
"type": "string"
|
| 1560 |
+
},
|
| 1561 |
+
"updateTime": {
|
| 1562 |
+
"description": "Output only. Time when the policy was last updated.",
|
| 1563 |
+
"format": "google-datetime",
|
| 1564 |
+
"readOnly": true,
|
| 1565 |
+
"type": "string"
|
| 1566 |
+
}
|
| 1567 |
+
},
|
| 1568 |
+
"type": "object"
|
| 1569 |
+
},
|
| 1570 |
+
"Scope": {
|
| 1571 |
+
"description": "A scope specifier for `CheckSet` objects.",
|
| 1572 |
+
"id": "Scope",
|
| 1573 |
+
"properties": {
|
| 1574 |
+
"kubernetesNamespace": {
|
| 1575 |
+
"description": "Optional. Matches all Kubernetes service accounts in the provided namespace, unless a more specific `kubernetes_service_account` scope already matched.",
|
| 1576 |
+
"type": "string"
|
| 1577 |
+
},
|
| 1578 |
+
"kubernetesServiceAccount": {
|
| 1579 |
+
"description": "Optional. Matches a single Kubernetes service account, e.g. `my-namespace:my-service-account`. `kubernetes_service_account` scope is always more specific than `kubernetes_namespace` scope for the same namespace.",
|
| 1580 |
+
"type": "string"
|
| 1581 |
+
}
|
| 1582 |
+
},
|
| 1583 |
+
"type": "object"
|
| 1584 |
+
},
|
| 1585 |
+
"SetIamPolicyRequest": {
|
| 1586 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 1587 |
+
"id": "SetIamPolicyRequest",
|
| 1588 |
+
"properties": {
|
| 1589 |
+
"policy": {
|
| 1590 |
+
"$ref": "IamPolicy",
|
| 1591 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 1592 |
+
}
|
| 1593 |
+
},
|
| 1594 |
+
"type": "object"
|
| 1595 |
+
},
|
| 1596 |
+
"Signature": {
|
| 1597 |
+
"description": "Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be \"attached\" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any \"attached\" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).",
|
| 1598 |
+
"id": "Signature",
|
| 1599 |
+
"properties": {
|
| 1600 |
+
"publicKeyId": {
|
| 1601 |
+
"description": "The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * \"openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA\" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * \"ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU\" * \"nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5\"",
|
| 1602 |
+
"type": "string"
|
| 1603 |
+
},
|
| 1604 |
+
"signature": {
|
| 1605 |
+
"description": "The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.",
|
| 1606 |
+
"format": "byte",
|
| 1607 |
+
"type": "string"
|
| 1608 |
+
}
|
| 1609 |
+
},
|
| 1610 |
+
"type": "object"
|
| 1611 |
+
},
|
| 1612 |
+
"SigstoreAuthority": {
|
| 1613 |
+
"description": "A Sigstore authority, used to verify signatures that are created by Sigstore. An authority is analogous to an attestation authenticator, verifying that a signature is valid or invalid.",
|
| 1614 |
+
"id": "SigstoreAuthority",
|
| 1615 |
+
"properties": {
|
| 1616 |
+
"displayName": {
|
| 1617 |
+
"description": "Optional. A user-provided name for this `SigstoreAuthority`. This field has no effect on the policy evaluation behavior except to improve readability of messages in evaluation results.",
|
| 1618 |
+
"type": "string"
|
| 1619 |
+
},
|
| 1620 |
+
"publicKeySet": {
|
| 1621 |
+
"$ref": "SigstorePublicKeySet",
|
| 1622 |
+
"description": "Required. A simple set of public keys. A signature is considered valid if any keys in the set validate the signature."
|
| 1623 |
+
}
|
| 1624 |
+
},
|
| 1625 |
+
"type": "object"
|
| 1626 |
+
},
|
| 1627 |
+
"SigstorePublicKey": {
|
| 1628 |
+
"description": "A Sigstore public key. `SigstorePublicKey` is the public key material used to authenticate Sigstore signatures.",
|
| 1629 |
+
"id": "SigstorePublicKey",
|
| 1630 |
+
"properties": {
|
| 1631 |
+
"publicKeyPem": {
|
| 1632 |
+
"description": "The public key material in PEM format.",
|
| 1633 |
+
"type": "string"
|
| 1634 |
+
}
|
| 1635 |
+
},
|
| 1636 |
+
"type": "object"
|
| 1637 |
+
},
|
| 1638 |
+
"SigstorePublicKeySet": {
|
| 1639 |
+
"description": "A bundle of Sigstore public keys, used to verify Sigstore signatures. A signature is authenticated by a `SigstorePublicKeySet` if any of the keys verify it.",
|
| 1640 |
+
"id": "SigstorePublicKeySet",
|
| 1641 |
+
"properties": {
|
| 1642 |
+
"publicKeys": {
|
| 1643 |
+
"description": "Required. `public_keys` must have at least one entry.",
|
| 1644 |
+
"items": {
|
| 1645 |
+
"$ref": "SigstorePublicKey"
|
| 1646 |
+
},
|
| 1647 |
+
"type": "array"
|
| 1648 |
+
}
|
| 1649 |
+
},
|
| 1650 |
+
"type": "object"
|
| 1651 |
+
},
|
| 1652 |
+
"SigstoreSignatureCheck": {
|
| 1653 |
+
"description": "A Sigstore signature check, which verifies the Sigstore signature associated with an image.",
|
| 1654 |
+
"id": "SigstoreSignatureCheck",
|
| 1655 |
+
"properties": {
|
| 1656 |
+
"sigstoreAuthorities": {
|
| 1657 |
+
"description": "Required. The authorities required by this check to verify the signature. A signature only needs to be verified by one authority to pass the check.",
|
| 1658 |
+
"items": {
|
| 1659 |
+
"$ref": "SigstoreAuthority"
|
| 1660 |
+
},
|
| 1661 |
+
"type": "array"
|
| 1662 |
+
}
|
| 1663 |
+
},
|
| 1664 |
+
"type": "object"
|
| 1665 |
+
},
|
| 1666 |
+
"SimpleSigningAttestationCheck": {
|
| 1667 |
+
"description": "Require a signed [DSSE](https://github.com/secure-systems-lab/dsse) attestation with type SimpleSigning.",
|
| 1668 |
+
"id": "SimpleSigningAttestationCheck",
|
| 1669 |
+
"properties": {
|
| 1670 |
+
"attestationAuthenticators": {
|
| 1671 |
+
"description": "Required. The authenticators required by this check to verify an attestation. Typically this is one or more PKIX public keys for signature verification. Only one authenticator needs to consider an attestation verified in order for an attestation to be considered fully authenticated. In otherwords, this list of authenticators is an \"OR\" of the authenticator results. At least one authenticator is required.",
|
| 1672 |
+
"items": {
|
| 1673 |
+
"$ref": "AttestationAuthenticator"
|
| 1674 |
+
},
|
| 1675 |
+
"type": "array"
|
| 1676 |
+
},
|
| 1677 |
+
"containerAnalysisAttestationProjects": {
|
| 1678 |
+
"description": "Optional. The projects where attestations are stored as Container Analysis Occurrences, in the format `projects/[PROJECT_ID]`. Only one attestation needs to successfully verify an image for this check to pass, so a single verified attestation found in any of `container_analysis_attestation_projects` is sufficient for the check to pass. A project ID must be used, not a project number. When fetching Occurrences from Container Analysis, only `AttestationOccurrence` kinds are considered. In the future, additional Occurrence kinds may be added to the query. Maximum number of `container_analysis_attestation_projects` allowed in each `SimpleSigningAttestationCheck` is 10.",
|
| 1679 |
+
"items": {
|
| 1680 |
+
"type": "string"
|
| 1681 |
+
},
|
| 1682 |
+
"type": "array"
|
| 1683 |
+
}
|
| 1684 |
+
},
|
| 1685 |
+
"type": "object"
|
| 1686 |
+
},
|
| 1687 |
+
"SlsaCheck": {
|
| 1688 |
+
"description": "A SLSA provenance attestation check, which ensures that images are built by a trusted builder using source code from its trusted repositories only.",
|
| 1689 |
+
"id": "SlsaCheck",
|
| 1690 |
+
"properties": {
|
| 1691 |
+
"rules": {
|
| 1692 |
+
"description": "Specifies a list of verification rules for the SLSA attestations. An image is considered compliant with the SlsaCheck if any of the rules are satisfied.",
|
| 1693 |
+
"items": {
|
| 1694 |
+
"$ref": "VerificationRule"
|
| 1695 |
+
},
|
| 1696 |
+
"type": "array"
|
| 1697 |
+
}
|
| 1698 |
+
},
|
| 1699 |
+
"type": "object"
|
| 1700 |
+
},
|
| 1701 |
+
"TestIamPermissionsRequest": {
|
| 1702 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 1703 |
+
"id": "TestIamPermissionsRequest",
|
| 1704 |
+
"properties": {
|
| 1705 |
+
"permissions": {
|
| 1706 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 1707 |
+
"items": {
|
| 1708 |
+
"type": "string"
|
| 1709 |
+
},
|
| 1710 |
+
"type": "array"
|
| 1711 |
+
}
|
| 1712 |
+
},
|
| 1713 |
+
"type": "object"
|
| 1714 |
+
},
|
| 1715 |
+
"TestIamPermissionsResponse": {
|
| 1716 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 1717 |
+
"id": "TestIamPermissionsResponse",
|
| 1718 |
+
"properties": {
|
| 1719 |
+
"permissions": {
|
| 1720 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 1721 |
+
"items": {
|
| 1722 |
+
"type": "string"
|
| 1723 |
+
},
|
| 1724 |
+
"type": "array"
|
| 1725 |
+
}
|
| 1726 |
+
},
|
| 1727 |
+
"type": "object"
|
| 1728 |
+
},
|
| 1729 |
+
"TrustedDirectoryCheck": {
|
| 1730 |
+
"description": "A trusted directory check, which rejects images that do not come from the set of user-configured trusted directories.",
|
| 1731 |
+
"id": "TrustedDirectoryCheck",
|
| 1732 |
+
"properties": {
|
| 1733 |
+
"trustedDirPatterns": {
|
| 1734 |
+
"description": "Required. List of trusted directory patterns. A pattern is in the form \"registry/path/to/directory\". The registry domain part is defined as two or more dot-separated words, e.g., `us.pkg.dev`, or `gcr.io`. Additionally, `*` can be used in three ways as wildcards: 1. leading `*` to match varying prefixes in registry subdomain (useful for location prefixes); 2. trailing `*` after registry/ to match varying endings; 3. trailing `**` after registry/ to match \"/\" as well. For example: -- `gcr.io/my-project/my-repo` is valid to match a single directory -- `*-docker.pkg.dev/my-project/my-repo` or `*.gcr.io/my-project` are valid to match varying prefixes -- `gcr.io/my-project/*` will match all direct directories in `my-project` -- `gcr.io/my-project/**` would match all directories in `my-project` -- `gcr.i*` is not allowed since the registry is not completely specified -- `sub*domain.gcr.io/nginx` is not valid because only leading `*` or trailing `*` are allowed. -- `*pkg.dev/my-project/my-repo` is not valid because leading `*` can only match subdomain -- `**-docker.pkg.dev` is not valid because one leading `*` is allowed, and that it cannot match `/`",
|
| 1735 |
+
"items": {
|
| 1736 |
+
"type": "string"
|
| 1737 |
+
},
|
| 1738 |
+
"type": "array"
|
| 1739 |
+
}
|
| 1740 |
+
},
|
| 1741 |
+
"type": "object"
|
| 1742 |
+
},
|
| 1743 |
+
"UserOwnedGrafeasNote": {
|
| 1744 |
+
"description": "An user owned Grafeas note references a Grafeas Attestation.Authority Note created by the user.",
|
| 1745 |
+
"id": "UserOwnedGrafeasNote",
|
| 1746 |
+
"properties": {
|
| 1747 |
+
"delegationServiceAccountEmail": {
|
| 1748 |
+
"description": "Output only. This field will contain the service account email address that this attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the note_reference in Container Analysis (`containeranalysis.notes.occurrences.viewer`). This email address is fixed for the lifetime of the attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern.",
|
| 1749 |
+
"readOnly": true,
|
| 1750 |
+
"type": "string"
|
| 1751 |
+
},
|
| 1752 |
+
"noteReference": {
|
| 1753 |
+
"description": "Required. The Grafeas resource name of a Attestation.Authority Note, created by the user, in the format: `projects/[PROJECT_ID]/notes/*`. This field may not be updated. A project ID must be used, not a project number. An attestation by this attestor is stored as a Grafeas Attestation.Authority Occurrence that names a container image and that links to this Note. Grafeas is an external dependency.",
|
| 1754 |
+
"type": "string"
|
| 1755 |
+
},
|
| 1756 |
+
"publicKeys": {
|
| 1757 |
+
"description": "Optional. Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist.",
|
| 1758 |
+
"items": {
|
| 1759 |
+
"$ref": "AttestorPublicKey"
|
| 1760 |
+
},
|
| 1761 |
+
"type": "array"
|
| 1762 |
+
}
|
| 1763 |
+
},
|
| 1764 |
+
"type": "object"
|
| 1765 |
+
},
|
| 1766 |
+
"ValidateAttestationOccurrenceRequest": {
|
| 1767 |
+
"description": "Request message for ValidationHelperV1.ValidateAttestationOccurrence.",
|
| 1768 |
+
"id": "ValidateAttestationOccurrenceRequest",
|
| 1769 |
+
"properties": {
|
| 1770 |
+
"attestation": {
|
| 1771 |
+
"$ref": "AttestationOccurrence",
|
| 1772 |
+
"description": "Required. An AttestationOccurrence to be checked that it can be verified by the `Attestor`. It does not have to be an existing entity in Container Analysis. It must otherwise be a valid `AttestationOccurrence`."
|
| 1773 |
+
},
|
| 1774 |
+
"occurrenceNote": {
|
| 1775 |
+
"description": "Required. The resource name of the Note to which the containing Occurrence is associated.",
|
| 1776 |
+
"type": "string"
|
| 1777 |
+
},
|
| 1778 |
+
"occurrenceResourceUri": {
|
| 1779 |
+
"description": "Required. The URI of the artifact (e.g. container image) that is the subject of the containing Occurrence.",
|
| 1780 |
+
"type": "string"
|
| 1781 |
+
}
|
| 1782 |
+
},
|
| 1783 |
+
"type": "object"
|
| 1784 |
+
},
|
| 1785 |
+
"ValidateAttestationOccurrenceResponse": {
|
| 1786 |
+
"description": "Response message for ValidationHelperV1.ValidateAttestationOccurrence.",
|
| 1787 |
+
"id": "ValidateAttestationOccurrenceResponse",
|
| 1788 |
+
"properties": {
|
| 1789 |
+
"denialReason": {
|
| 1790 |
+
"description": "The reason for denial if the Attestation couldn't be validated.",
|
| 1791 |
+
"type": "string"
|
| 1792 |
+
},
|
| 1793 |
+
"result": {
|
| 1794 |
+
"description": "The result of the Attestation validation.",
|
| 1795 |
+
"enum": [
|
| 1796 |
+
"RESULT_UNSPECIFIED",
|
| 1797 |
+
"VERIFIED",
|
| 1798 |
+
"ATTESTATION_NOT_VERIFIABLE"
|
| 1799 |
+
],
|
| 1800 |
+
"enumDescriptions": [
|
| 1801 |
+
"Unspecified.",
|
| 1802 |
+
"The Attestation was able to verified by the Attestor.",
|
| 1803 |
+
"The Attestation was not able to verified by the Attestor."
|
| 1804 |
+
],
|
| 1805 |
+
"type": "string"
|
| 1806 |
+
}
|
| 1807 |
+
},
|
| 1808 |
+
"type": "object"
|
| 1809 |
+
},
|
| 1810 |
+
"VerificationRule": {
|
| 1811 |
+
"description": "Specifies verification rules for evaluating the SLSA attestations including: which builders to trust, where to fetch the SLSA attestations generated by those builders, and other builder-specific evaluation rules such as which source repositories are trusted. An image is considered verified by the rule if any of the fetched SLSA attestations is verified.",
|
| 1812 |
+
"id": "VerificationRule",
|
| 1813 |
+
"properties": {
|
| 1814 |
+
"attestationSource": {
|
| 1815 |
+
"$ref": "AttestationSource",
|
| 1816 |
+
"description": "Specifies where to fetch the provenances attestations generated by the builder (group)."
|
| 1817 |
+
},
|
| 1818 |
+
"configBasedBuildRequired": {
|
| 1819 |
+
"description": "If true, require the image to be built from a top-level configuration. `trusted_source_repo_patterns` specifies the repositories containing this configuration.",
|
| 1820 |
+
"type": "boolean"
|
| 1821 |
+
},
|
| 1822 |
+
"trustedBuilder": {
|
| 1823 |
+
"description": "Each verification rule is used for evaluation against provenances generated by a specific builder (group). For some of the builders, such as the Google Cloud Build, users don't need to explicitly specify their roots of trust in the policy since the evaluation service can automatically fetch them based on the builder (group).",
|
| 1824 |
+
"enum": [
|
| 1825 |
+
"BUILDER_UNSPECIFIED",
|
| 1826 |
+
"GOOGLE_CLOUD_BUILD"
|
| 1827 |
+
],
|
| 1828 |
+
"enumDescriptions": [
|
| 1829 |
+
"Should never happen.",
|
| 1830 |
+
"The whole Google Cloud Build (GCB) builder group, including all GCB builder types."
|
| 1831 |
+
],
|
| 1832 |
+
"type": "string"
|
| 1833 |
+
},
|
| 1834 |
+
"trustedSourceRepoPatterns": {
|
| 1835 |
+
"description": "List of trusted source code repository URL patterns. These patterns match the full repository URL without its scheme (e.g. `https://`). The patterns must not include schemes. For example, the pattern `source.cloud.google.com/my-project/my-repo-name` matches the following URLs: - `source.cloud.google.com/my-project/my-repo-name` - `git+ssh://source.cloud.google.com/my-project/my-repo-name` - `https://source.cloud.google.com/my-project/my-repo-name` A pattern matches a URL either exactly or with `*` wildcards. `*` can be used in only two ways: 1. trailing `*` after hosturi/ to match varying endings; 2. trailing `**` after hosturi/ to match `/` as well. `*` and `**` can only be used as wildcards and can only occur at the end of the pattern after a `/`. (So it's not possible to match a URL that contains literal `*`.) For example: - `github.com/my-project/my-repo` is valid to match a single repo - `github.com/my-project/*` will match all direct repos in `my-project` - `github.com/**` matches all repos in GitHub",
|
| 1836 |
+
"items": {
|
| 1837 |
+
"type": "string"
|
| 1838 |
+
},
|
| 1839 |
+
"type": "array"
|
| 1840 |
+
}
|
| 1841 |
+
},
|
| 1842 |
+
"type": "object"
|
| 1843 |
+
},
|
| 1844 |
+
"VulnerabilityCheck": {
|
| 1845 |
+
"description": "An image vulnerability check, which rejects images that violate the configured vulnerability rules.",
|
| 1846 |
+
"id": "VulnerabilityCheck",
|
| 1847 |
+
"properties": {
|
| 1848 |
+
"allowedCves": {
|
| 1849 |
+
"description": "Optional. A list of specific CVEs to ignore even if the vulnerability level violates `maximumUnfixableSeverity` or `maximumFixableSeverity`. CVEs are listed in the format of Container Analysis note id. For example: - CVE-2021-20305 - CVE-2020-10543 The CVEs are applicable regardless of note provider project, e.g., an entry of `CVE-2021-20305` will allow vulnerabilities with a note name of either `projects/goog-vulnz/notes/CVE-2021-20305` or `projects/CUSTOM-PROJECT/notes/CVE-2021-20305`.",
|
| 1850 |
+
"items": {
|
| 1851 |
+
"type": "string"
|
| 1852 |
+
},
|
| 1853 |
+
"type": "array"
|
| 1854 |
+
},
|
| 1855 |
+
"blockedCves": {
|
| 1856 |
+
"description": "Optional. A list of specific CVEs to always raise warnings about even if the vulnerability level meets `maximumUnfixableSeverity` or `maximumFixableSeverity`. CVEs are listed in the format of Container Analysis note id. For example: - CVE-2021-20305 - CVE-2020-10543 The CVEs are applicable regardless of note provider project, e.g., an entry of `CVE-2021-20305` will block vulnerabilities with a note name of either `projects/goog-vulnz/notes/CVE-2021-20305` or `projects/CUSTOM-PROJECT/notes/CVE-2021-20305`.",
|
| 1857 |
+
"items": {
|
| 1858 |
+
"type": "string"
|
| 1859 |
+
},
|
| 1860 |
+
"type": "array"
|
| 1861 |
+
},
|
| 1862 |
+
"containerAnalysisVulnerabilityProjects": {
|
| 1863 |
+
"description": "Optional. The projects where vulnerabilities are stored as Container Analysis Occurrences. Each project is expressed in the resource format of `projects/[PROJECT_ID]`, e.g., `projects/my-gcp-project`. An attempt will be made for each project to fetch vulnerabilities, and all valid vulnerabilities will be used to check against the vulnerability policy. If no valid scan is found in all projects configured here, an error will be returned for the check. Maximum number of `container_analysis_vulnerability_projects` allowed in each `VulnerabilityCheck` is 10.",
|
| 1864 |
+
"items": {
|
| 1865 |
+
"type": "string"
|
| 1866 |
+
},
|
| 1867 |
+
"type": "array"
|
| 1868 |
+
},
|
| 1869 |
+
"maximumFixableSeverity": {
|
| 1870 |
+
"description": "Required. The threshold for severity for which a fix is currently available. This field is required and must be set.",
|
| 1871 |
+
"enum": [
|
| 1872 |
+
"MAXIMUM_ALLOWED_SEVERITY_UNSPECIFIED",
|
| 1873 |
+
"BLOCK_ALL",
|
| 1874 |
+
"MINIMAL",
|
| 1875 |
+
"LOW",
|
| 1876 |
+
"MEDIUM",
|
| 1877 |
+
"HIGH",
|
| 1878 |
+
"CRITICAL",
|
| 1879 |
+
"ALLOW_ALL"
|
| 1880 |
+
],
|
| 1881 |
+
"enumDescriptions": [
|
| 1882 |
+
"Not specified.",
|
| 1883 |
+
"Block any vulnerability.",
|
| 1884 |
+
"Allow only minimal severity.",
|
| 1885 |
+
"Allow only low severity and lower.",
|
| 1886 |
+
"Allow medium severity and lower.",
|
| 1887 |
+
"Allow high severity and lower.",
|
| 1888 |
+
"Allow critical severity and lower.",
|
| 1889 |
+
"Allow all severity, even vulnerability with unspecified severity."
|
| 1890 |
+
],
|
| 1891 |
+
"type": "string"
|
| 1892 |
+
},
|
| 1893 |
+
"maximumUnfixableSeverity": {
|
| 1894 |
+
"description": "Required. The threshold for severity for which a fix isn't currently available. This field is required and must be set.",
|
| 1895 |
+
"enum": [
|
| 1896 |
+
"MAXIMUM_ALLOWED_SEVERITY_UNSPECIFIED",
|
| 1897 |
+
"BLOCK_ALL",
|
| 1898 |
+
"MINIMAL",
|
| 1899 |
+
"LOW",
|
| 1900 |
+
"MEDIUM",
|
| 1901 |
+
"HIGH",
|
| 1902 |
+
"CRITICAL",
|
| 1903 |
+
"ALLOW_ALL"
|
| 1904 |
+
],
|
| 1905 |
+
"enumDescriptions": [
|
| 1906 |
+
"Not specified.",
|
| 1907 |
+
"Block any vulnerability.",
|
| 1908 |
+
"Allow only minimal severity.",
|
| 1909 |
+
"Allow only low severity and lower.",
|
| 1910 |
+
"Allow medium severity and lower.",
|
| 1911 |
+
"Allow high severity and lower.",
|
| 1912 |
+
"Allow critical severity and lower.",
|
| 1913 |
+
"Allow all severity, even vulnerability with unspecified severity."
|
| 1914 |
+
],
|
| 1915 |
+
"type": "string"
|
| 1916 |
+
}
|
| 1917 |
+
},
|
| 1918 |
+
"type": "object"
|
| 1919 |
+
}
|
| 1920 |
+
},
|
| 1921 |
+
"servicePath": "",
|
| 1922 |
+
"title": "Binary Authorization API",
|
| 1923 |
+
"version": "v1",
|
| 1924 |
+
"version_module": true
|
| 1925 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json
ADDED
|
@@ -0,0 +1,679 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"basePath": "",
|
| 3 |
+
"baseUrl": "https://businessprofileperformance.googleapis.com/",
|
| 4 |
+
"batchPath": "batch",
|
| 5 |
+
"canonicalName": "Business Profile Performance",
|
| 6 |
+
"description": "The Business Profile Performance API allows merchants to fetch performance reports about their business profile on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.",
|
| 7 |
+
"discoveryVersion": "v1",
|
| 8 |
+
"documentationLink": "https://developers.google.com/my-business/",
|
| 9 |
+
"fullyEncodeReservedExpansion": true,
|
| 10 |
+
"icons": {
|
| 11 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 12 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 13 |
+
},
|
| 14 |
+
"id": "businessprofileperformance:v1",
|
| 15 |
+
"kind": "discovery#restDescription",
|
| 16 |
+
"mtlsRootUrl": "https://businessprofileperformance.mtls.googleapis.com/",
|
| 17 |
+
"name": "businessprofileperformance",
|
| 18 |
+
"ownerDomain": "google.com",
|
| 19 |
+
"ownerName": "Google",
|
| 20 |
+
"parameters": {
|
| 21 |
+
"$.xgafv": {
|
| 22 |
+
"description": "V1 error format.",
|
| 23 |
+
"enum": [
|
| 24 |
+
"1",
|
| 25 |
+
"2"
|
| 26 |
+
],
|
| 27 |
+
"enumDescriptions": [
|
| 28 |
+
"v1 error format",
|
| 29 |
+
"v2 error format"
|
| 30 |
+
],
|
| 31 |
+
"location": "query",
|
| 32 |
+
"type": "string"
|
| 33 |
+
},
|
| 34 |
+
"access_token": {
|
| 35 |
+
"description": "OAuth access token.",
|
| 36 |
+
"location": "query",
|
| 37 |
+
"type": "string"
|
| 38 |
+
},
|
| 39 |
+
"alt": {
|
| 40 |
+
"default": "json",
|
| 41 |
+
"description": "Data format for response.",
|
| 42 |
+
"enum": [
|
| 43 |
+
"json",
|
| 44 |
+
"media",
|
| 45 |
+
"proto"
|
| 46 |
+
],
|
| 47 |
+
"enumDescriptions": [
|
| 48 |
+
"Responses with Content-Type of application/json",
|
| 49 |
+
"Media download with context-dependent Content-Type",
|
| 50 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 51 |
+
],
|
| 52 |
+
"location": "query",
|
| 53 |
+
"type": "string"
|
| 54 |
+
},
|
| 55 |
+
"callback": {
|
| 56 |
+
"description": "JSONP",
|
| 57 |
+
"location": "query",
|
| 58 |
+
"type": "string"
|
| 59 |
+
},
|
| 60 |
+
"fields": {
|
| 61 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 62 |
+
"location": "query",
|
| 63 |
+
"type": "string"
|
| 64 |
+
},
|
| 65 |
+
"key": {
|
| 66 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 67 |
+
"location": "query",
|
| 68 |
+
"type": "string"
|
| 69 |
+
},
|
| 70 |
+
"oauth_token": {
|
| 71 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 72 |
+
"location": "query",
|
| 73 |
+
"type": "string"
|
| 74 |
+
},
|
| 75 |
+
"prettyPrint": {
|
| 76 |
+
"default": "true",
|
| 77 |
+
"description": "Returns response with indentations and line breaks.",
|
| 78 |
+
"location": "query",
|
| 79 |
+
"type": "boolean"
|
| 80 |
+
},
|
| 81 |
+
"quotaUser": {
|
| 82 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 83 |
+
"location": "query",
|
| 84 |
+
"type": "string"
|
| 85 |
+
},
|
| 86 |
+
"uploadType": {
|
| 87 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 88 |
+
"location": "query",
|
| 89 |
+
"type": "string"
|
| 90 |
+
},
|
| 91 |
+
"upload_protocol": {
|
| 92 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 93 |
+
"location": "query",
|
| 94 |
+
"type": "string"
|
| 95 |
+
}
|
| 96 |
+
},
|
| 97 |
+
"protocol": "rest",
|
| 98 |
+
"resources": {
|
| 99 |
+
"locations": {
|
| 100 |
+
"methods": {
|
| 101 |
+
"fetchMultiDailyMetricsTimeSeries": {
|
| 102 |
+
"description": " Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`",
|
| 103 |
+
"flatPath": "v1/locations/{locationsId}:fetchMultiDailyMetricsTimeSeries",
|
| 104 |
+
"httpMethod": "GET",
|
| 105 |
+
"id": "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries",
|
| 106 |
+
"parameterOrder": [
|
| 107 |
+
"location"
|
| 108 |
+
],
|
| 109 |
+
"parameters": {
|
| 110 |
+
"dailyMetrics": {
|
| 111 |
+
"description": "Required. The metrics to retrieve time series for.",
|
| 112 |
+
"enum": [
|
| 113 |
+
"DAILY_METRIC_UNKNOWN",
|
| 114 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_MAPS",
|
| 115 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_SEARCH",
|
| 116 |
+
"BUSINESS_IMPRESSIONS_MOBILE_MAPS",
|
| 117 |
+
"BUSINESS_IMPRESSIONS_MOBILE_SEARCH",
|
| 118 |
+
"BUSINESS_CONVERSATIONS",
|
| 119 |
+
"BUSINESS_DIRECTION_REQUESTS",
|
| 120 |
+
"CALL_CLICKS",
|
| 121 |
+
"WEBSITE_CLICKS",
|
| 122 |
+
"BUSINESS_BOOKINGS",
|
| 123 |
+
"BUSINESS_FOOD_ORDERS",
|
| 124 |
+
"BUSINESS_FOOD_MENU_CLICKS"
|
| 125 |
+
],
|
| 126 |
+
"enumDescriptions": [
|
| 127 |
+
"Represents the default unknown value.",
|
| 128 |
+
"Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 129 |
+
"Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 130 |
+
"Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 131 |
+
"Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 132 |
+
"The number of message conversations received on the business profile.",
|
| 133 |
+
"The number of times a direction request was requested to the business location.",
|
| 134 |
+
"The number of times the business profile call button was clicked.",
|
| 135 |
+
"The number of times the business profile website was clicked.",
|
| 136 |
+
"The number of bookings made from the business profile via Reserve with Google.",
|
| 137 |
+
"The number of food orders received from the business profile.",
|
| 138 |
+
"The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1."
|
| 139 |
+
],
|
| 140 |
+
"location": "query",
|
| 141 |
+
"repeated": true,
|
| 142 |
+
"type": "string"
|
| 143 |
+
},
|
| 144 |
+
"dailyRange.endDate.day": {
|
| 145 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 146 |
+
"format": "int32",
|
| 147 |
+
"location": "query",
|
| 148 |
+
"type": "integer"
|
| 149 |
+
},
|
| 150 |
+
"dailyRange.endDate.month": {
|
| 151 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 152 |
+
"format": "int32",
|
| 153 |
+
"location": "query",
|
| 154 |
+
"type": "integer"
|
| 155 |
+
},
|
| 156 |
+
"dailyRange.endDate.year": {
|
| 157 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 158 |
+
"format": "int32",
|
| 159 |
+
"location": "query",
|
| 160 |
+
"type": "integer"
|
| 161 |
+
},
|
| 162 |
+
"dailyRange.startDate.day": {
|
| 163 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 164 |
+
"format": "int32",
|
| 165 |
+
"location": "query",
|
| 166 |
+
"type": "integer"
|
| 167 |
+
},
|
| 168 |
+
"dailyRange.startDate.month": {
|
| 169 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 170 |
+
"format": "int32",
|
| 171 |
+
"location": "query",
|
| 172 |
+
"type": "integer"
|
| 173 |
+
},
|
| 174 |
+
"dailyRange.startDate.year": {
|
| 175 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 176 |
+
"format": "int32",
|
| 177 |
+
"location": "query",
|
| 178 |
+
"type": "integer"
|
| 179 |
+
},
|
| 180 |
+
"location": {
|
| 181 |
+
"description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.",
|
| 182 |
+
"location": "path",
|
| 183 |
+
"pattern": "^locations/[^/]+$",
|
| 184 |
+
"required": true,
|
| 185 |
+
"type": "string"
|
| 186 |
+
}
|
| 187 |
+
},
|
| 188 |
+
"path": "v1/{+location}:fetchMultiDailyMetricsTimeSeries",
|
| 189 |
+
"response": {
|
| 190 |
+
"$ref": "FetchMultiDailyMetricsTimeSeriesResponse"
|
| 191 |
+
}
|
| 192 |
+
},
|
| 193 |
+
"getDailyMetricsTimeSeries": {
|
| 194 |
+
"description": " Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`",
|
| 195 |
+
"flatPath": "v1/locations/{locationsId}:getDailyMetricsTimeSeries",
|
| 196 |
+
"httpMethod": "GET",
|
| 197 |
+
"id": "businessprofileperformance.locations.getDailyMetricsTimeSeries",
|
| 198 |
+
"parameterOrder": [
|
| 199 |
+
"name"
|
| 200 |
+
],
|
| 201 |
+
"parameters": {
|
| 202 |
+
"dailyMetric": {
|
| 203 |
+
"description": "Required. The metric to retrieve time series.",
|
| 204 |
+
"enum": [
|
| 205 |
+
"DAILY_METRIC_UNKNOWN",
|
| 206 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_MAPS",
|
| 207 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_SEARCH",
|
| 208 |
+
"BUSINESS_IMPRESSIONS_MOBILE_MAPS",
|
| 209 |
+
"BUSINESS_IMPRESSIONS_MOBILE_SEARCH",
|
| 210 |
+
"BUSINESS_CONVERSATIONS",
|
| 211 |
+
"BUSINESS_DIRECTION_REQUESTS",
|
| 212 |
+
"CALL_CLICKS",
|
| 213 |
+
"WEBSITE_CLICKS",
|
| 214 |
+
"BUSINESS_BOOKINGS",
|
| 215 |
+
"BUSINESS_FOOD_ORDERS",
|
| 216 |
+
"BUSINESS_FOOD_MENU_CLICKS"
|
| 217 |
+
],
|
| 218 |
+
"enumDescriptions": [
|
| 219 |
+
"Represents the default unknown value.",
|
| 220 |
+
"Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 221 |
+
"Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 222 |
+
"Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 223 |
+
"Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 224 |
+
"The number of message conversations received on the business profile.",
|
| 225 |
+
"The number of times a direction request was requested to the business location.",
|
| 226 |
+
"The number of times the business profile call button was clicked.",
|
| 227 |
+
"The number of times the business profile website was clicked.",
|
| 228 |
+
"The number of bookings made from the business profile via Reserve with Google.",
|
| 229 |
+
"The number of food orders received from the business profile.",
|
| 230 |
+
"The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1."
|
| 231 |
+
],
|
| 232 |
+
"location": "query",
|
| 233 |
+
"type": "string"
|
| 234 |
+
},
|
| 235 |
+
"dailyRange.endDate.day": {
|
| 236 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 237 |
+
"format": "int32",
|
| 238 |
+
"location": "query",
|
| 239 |
+
"type": "integer"
|
| 240 |
+
},
|
| 241 |
+
"dailyRange.endDate.month": {
|
| 242 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 243 |
+
"format": "int32",
|
| 244 |
+
"location": "query",
|
| 245 |
+
"type": "integer"
|
| 246 |
+
},
|
| 247 |
+
"dailyRange.endDate.year": {
|
| 248 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 249 |
+
"format": "int32",
|
| 250 |
+
"location": "query",
|
| 251 |
+
"type": "integer"
|
| 252 |
+
},
|
| 253 |
+
"dailyRange.startDate.day": {
|
| 254 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 255 |
+
"format": "int32",
|
| 256 |
+
"location": "query",
|
| 257 |
+
"type": "integer"
|
| 258 |
+
},
|
| 259 |
+
"dailyRange.startDate.month": {
|
| 260 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 261 |
+
"format": "int32",
|
| 262 |
+
"location": "query",
|
| 263 |
+
"type": "integer"
|
| 264 |
+
},
|
| 265 |
+
"dailyRange.startDate.year": {
|
| 266 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 267 |
+
"format": "int32",
|
| 268 |
+
"location": "query",
|
| 269 |
+
"type": "integer"
|
| 270 |
+
},
|
| 271 |
+
"dailySubEntityType.dayOfWeek": {
|
| 272 |
+
"description": "Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.",
|
| 273 |
+
"enum": [
|
| 274 |
+
"DAY_OF_WEEK_UNSPECIFIED",
|
| 275 |
+
"MONDAY",
|
| 276 |
+
"TUESDAY",
|
| 277 |
+
"WEDNESDAY",
|
| 278 |
+
"THURSDAY",
|
| 279 |
+
"FRIDAY",
|
| 280 |
+
"SATURDAY",
|
| 281 |
+
"SUNDAY"
|
| 282 |
+
],
|
| 283 |
+
"enumDescriptions": [
|
| 284 |
+
"The day of the week is unspecified.",
|
| 285 |
+
"Monday",
|
| 286 |
+
"Tuesday",
|
| 287 |
+
"Wednesday",
|
| 288 |
+
"Thursday",
|
| 289 |
+
"Friday",
|
| 290 |
+
"Saturday",
|
| 291 |
+
"Sunday"
|
| 292 |
+
],
|
| 293 |
+
"location": "query",
|
| 294 |
+
"type": "string"
|
| 295 |
+
},
|
| 296 |
+
"dailySubEntityType.timeOfDay.hours": {
|
| 297 |
+
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
|
| 298 |
+
"format": "int32",
|
| 299 |
+
"location": "query",
|
| 300 |
+
"type": "integer"
|
| 301 |
+
},
|
| 302 |
+
"dailySubEntityType.timeOfDay.minutes": {
|
| 303 |
+
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
|
| 304 |
+
"format": "int32",
|
| 305 |
+
"location": "query",
|
| 306 |
+
"type": "integer"
|
| 307 |
+
},
|
| 308 |
+
"dailySubEntityType.timeOfDay.nanos": {
|
| 309 |
+
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
|
| 310 |
+
"format": "int32",
|
| 311 |
+
"location": "query",
|
| 312 |
+
"type": "integer"
|
| 313 |
+
},
|
| 314 |
+
"dailySubEntityType.timeOfDay.seconds": {
|
| 315 |
+
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
|
| 316 |
+
"format": "int32",
|
| 317 |
+
"location": "query",
|
| 318 |
+
"type": "integer"
|
| 319 |
+
},
|
| 320 |
+
"name": {
|
| 321 |
+
"description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.",
|
| 322 |
+
"location": "path",
|
| 323 |
+
"pattern": "^locations/[^/]+$",
|
| 324 |
+
"required": true,
|
| 325 |
+
"type": "string"
|
| 326 |
+
}
|
| 327 |
+
},
|
| 328 |
+
"path": "v1/{+name}:getDailyMetricsTimeSeries",
|
| 329 |
+
"response": {
|
| 330 |
+
"$ref": "GetDailyMetricsTimeSeriesResponse"
|
| 331 |
+
}
|
| 332 |
+
}
|
| 333 |
+
},
|
| 334 |
+
"resources": {
|
| 335 |
+
"searchkeywords": {
|
| 336 |
+
"resources": {
|
| 337 |
+
"impressions": {
|
| 338 |
+
"resources": {
|
| 339 |
+
"monthly": {
|
| 340 |
+
"methods": {
|
| 341 |
+
"list": {
|
| 342 |
+
"description": "Returns the search keywords used to find a business in search or maps. Each search keyword is accompanied by impressions which are aggregated on a monthly basis. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3`",
|
| 343 |
+
"flatPath": "v1/locations/{locationsId}/searchkeywords/impressions/monthly",
|
| 344 |
+
"httpMethod": "GET",
|
| 345 |
+
"id": "businessprofileperformance.locations.searchkeywords.impressions.monthly.list",
|
| 346 |
+
"parameterOrder": [
|
| 347 |
+
"parent"
|
| 348 |
+
],
|
| 349 |
+
"parameters": {
|
| 350 |
+
"monthlyRange.endMonth.day": {
|
| 351 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 352 |
+
"format": "int32",
|
| 353 |
+
"location": "query",
|
| 354 |
+
"type": "integer"
|
| 355 |
+
},
|
| 356 |
+
"monthlyRange.endMonth.month": {
|
| 357 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 358 |
+
"format": "int32",
|
| 359 |
+
"location": "query",
|
| 360 |
+
"type": "integer"
|
| 361 |
+
},
|
| 362 |
+
"monthlyRange.endMonth.year": {
|
| 363 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 364 |
+
"format": "int32",
|
| 365 |
+
"location": "query",
|
| 366 |
+
"type": "integer"
|
| 367 |
+
},
|
| 368 |
+
"monthlyRange.startMonth.day": {
|
| 369 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 370 |
+
"format": "int32",
|
| 371 |
+
"location": "query",
|
| 372 |
+
"type": "integer"
|
| 373 |
+
},
|
| 374 |
+
"monthlyRange.startMonth.month": {
|
| 375 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 376 |
+
"format": "int32",
|
| 377 |
+
"location": "query",
|
| 378 |
+
"type": "integer"
|
| 379 |
+
},
|
| 380 |
+
"monthlyRange.startMonth.year": {
|
| 381 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 382 |
+
"format": "int32",
|
| 383 |
+
"location": "query",
|
| 384 |
+
"type": "integer"
|
| 385 |
+
},
|
| 386 |
+
"pageSize": {
|
| 387 |
+
"description": "Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.",
|
| 388 |
+
"format": "int32",
|
| 389 |
+
"location": "query",
|
| 390 |
+
"type": "integer"
|
| 391 |
+
},
|
| 392 |
+
"pageToken": {
|
| 393 |
+
"description": "Optional. A token indicating the next paginated result to be returned.",
|
| 394 |
+
"format": "byte",
|
| 395 |
+
"location": "query",
|
| 396 |
+
"type": "string"
|
| 397 |
+
},
|
| 398 |
+
"parent": {
|
| 399 |
+
"description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.",
|
| 400 |
+
"location": "path",
|
| 401 |
+
"pattern": "^locations/[^/]+$",
|
| 402 |
+
"required": true,
|
| 403 |
+
"type": "string"
|
| 404 |
+
}
|
| 405 |
+
},
|
| 406 |
+
"path": "v1/{+parent}/searchkeywords/impressions/monthly",
|
| 407 |
+
"response": {
|
| 408 |
+
"$ref": "ListSearchKeywordImpressionsMonthlyResponse"
|
| 409 |
+
}
|
| 410 |
+
}
|
| 411 |
+
}
|
| 412 |
+
}
|
| 413 |
+
}
|
| 414 |
+
}
|
| 415 |
+
}
|
| 416 |
+
}
|
| 417 |
+
}
|
| 418 |
+
}
|
| 419 |
+
},
|
| 420 |
+
"revision": "20241002",
|
| 421 |
+
"rootUrl": "https://businessprofileperformance.googleapis.com/",
|
| 422 |
+
"schemas": {
|
| 423 |
+
"DailyMetricTimeSeries": {
|
| 424 |
+
"description": "Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple.",
|
| 425 |
+
"id": "DailyMetricTimeSeries",
|
| 426 |
+
"properties": {
|
| 427 |
+
"dailyMetric": {
|
| 428 |
+
"description": "The DailyMetric that the TimeSeries represents.",
|
| 429 |
+
"enum": [
|
| 430 |
+
"DAILY_METRIC_UNKNOWN",
|
| 431 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_MAPS",
|
| 432 |
+
"BUSINESS_IMPRESSIONS_DESKTOP_SEARCH",
|
| 433 |
+
"BUSINESS_IMPRESSIONS_MOBILE_MAPS",
|
| 434 |
+
"BUSINESS_IMPRESSIONS_MOBILE_SEARCH",
|
| 435 |
+
"BUSINESS_CONVERSATIONS",
|
| 436 |
+
"BUSINESS_DIRECTION_REQUESTS",
|
| 437 |
+
"CALL_CLICKS",
|
| 438 |
+
"WEBSITE_CLICKS",
|
| 439 |
+
"BUSINESS_BOOKINGS",
|
| 440 |
+
"BUSINESS_FOOD_ORDERS",
|
| 441 |
+
"BUSINESS_FOOD_MENU_CLICKS"
|
| 442 |
+
],
|
| 443 |
+
"enumDescriptions": [
|
| 444 |
+
"Represents the default unknown value.",
|
| 445 |
+
"Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 446 |
+
"Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 447 |
+
"Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 448 |
+
"Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.",
|
| 449 |
+
"The number of message conversations received on the business profile.",
|
| 450 |
+
"The number of times a direction request was requested to the business location.",
|
| 451 |
+
"The number of times the business profile call button was clicked.",
|
| 452 |
+
"The number of times the business profile website was clicked.",
|
| 453 |
+
"The number of bookings made from the business profile via Reserve with Google.",
|
| 454 |
+
"The number of food orders received from the business profile.",
|
| 455 |
+
"The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1."
|
| 456 |
+
],
|
| 457 |
+
"type": "string"
|
| 458 |
+
},
|
| 459 |
+
"dailySubEntityType": {
|
| 460 |
+
"$ref": "DailySubEntityType",
|
| 461 |
+
"description": "The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist."
|
| 462 |
+
},
|
| 463 |
+
"timeSeries": {
|
| 464 |
+
"$ref": "TimeSeries",
|
| 465 |
+
"description": "List of datapoints where each datapoint is a date-value pair."
|
| 466 |
+
}
|
| 467 |
+
},
|
| 468 |
+
"type": "object"
|
| 469 |
+
},
|
| 470 |
+
"DailySubEntityType": {
|
| 471 |
+
"description": "Represents all possible subentity types that are associated with DailyMetrics.",
|
| 472 |
+
"id": "DailySubEntityType",
|
| 473 |
+
"properties": {
|
| 474 |
+
"dayOfWeek": {
|
| 475 |
+
"description": "Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.",
|
| 476 |
+
"enum": [
|
| 477 |
+
"DAY_OF_WEEK_UNSPECIFIED",
|
| 478 |
+
"MONDAY",
|
| 479 |
+
"TUESDAY",
|
| 480 |
+
"WEDNESDAY",
|
| 481 |
+
"THURSDAY",
|
| 482 |
+
"FRIDAY",
|
| 483 |
+
"SATURDAY",
|
| 484 |
+
"SUNDAY"
|
| 485 |
+
],
|
| 486 |
+
"enumDescriptions": [
|
| 487 |
+
"The day of the week is unspecified.",
|
| 488 |
+
"Monday",
|
| 489 |
+
"Tuesday",
|
| 490 |
+
"Wednesday",
|
| 491 |
+
"Thursday",
|
| 492 |
+
"Friday",
|
| 493 |
+
"Saturday",
|
| 494 |
+
"Sunday"
|
| 495 |
+
],
|
| 496 |
+
"type": "string"
|
| 497 |
+
},
|
| 498 |
+
"timeOfDay": {
|
| 499 |
+
"$ref": "TimeOfDay",
|
| 500 |
+
"description": "Represents the time of the day in 24 hour format. Eg: 13:34:20 Currently supported DailyMetrics = NONE."
|
| 501 |
+
}
|
| 502 |
+
},
|
| 503 |
+
"type": "object"
|
| 504 |
+
},
|
| 505 |
+
"Date": {
|
| 506 |
+
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
|
| 507 |
+
"id": "Date",
|
| 508 |
+
"properties": {
|
| 509 |
+
"day": {
|
| 510 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 511 |
+
"format": "int32",
|
| 512 |
+
"type": "integer"
|
| 513 |
+
},
|
| 514 |
+
"month": {
|
| 515 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 516 |
+
"format": "int32",
|
| 517 |
+
"type": "integer"
|
| 518 |
+
},
|
| 519 |
+
"year": {
|
| 520 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 521 |
+
"format": "int32",
|
| 522 |
+
"type": "integer"
|
| 523 |
+
}
|
| 524 |
+
},
|
| 525 |
+
"type": "object"
|
| 526 |
+
},
|
| 527 |
+
"DatedValue": {
|
| 528 |
+
"description": "Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.",
|
| 529 |
+
"id": "DatedValue",
|
| 530 |
+
"properties": {
|
| 531 |
+
"date": {
|
| 532 |
+
"$ref": "Date",
|
| 533 |
+
"description": "The date that the datapoint corresponds to. This represents a month value if the day field is not set."
|
| 534 |
+
},
|
| 535 |
+
"value": {
|
| 536 |
+
"description": "The value of the datapoint. This will not be present when the value is zero.",
|
| 537 |
+
"format": "int64",
|
| 538 |
+
"type": "string"
|
| 539 |
+
}
|
| 540 |
+
},
|
| 541 |
+
"type": "object"
|
| 542 |
+
},
|
| 543 |
+
"FetchMultiDailyMetricsTimeSeriesResponse": {
|
| 544 |
+
"description": "Represents the response for FetchMultiDailyMetricsTimeSeries.",
|
| 545 |
+
"id": "FetchMultiDailyMetricsTimeSeriesResponse",
|
| 546 |
+
"properties": {
|
| 547 |
+
"multiDailyMetricTimeSeries": {
|
| 548 |
+
"description": "DailyMetrics and their corresponding time series.",
|
| 549 |
+
"items": {
|
| 550 |
+
"$ref": "MultiDailyMetricTimeSeries"
|
| 551 |
+
},
|
| 552 |
+
"type": "array"
|
| 553 |
+
}
|
| 554 |
+
},
|
| 555 |
+
"type": "object"
|
| 556 |
+
},
|
| 557 |
+
"GetDailyMetricsTimeSeriesResponse": {
|
| 558 |
+
"description": "Represents the response for GetDailyMetricsTimeSeries.",
|
| 559 |
+
"id": "GetDailyMetricsTimeSeriesResponse",
|
| 560 |
+
"properties": {
|
| 561 |
+
"timeSeries": {
|
| 562 |
+
"$ref": "TimeSeries",
|
| 563 |
+
"description": "The daily time series."
|
| 564 |
+
}
|
| 565 |
+
},
|
| 566 |
+
"type": "object"
|
| 567 |
+
},
|
| 568 |
+
"InsightsValue": {
|
| 569 |
+
"description": "Represents an insights value.",
|
| 570 |
+
"id": "InsightsValue",
|
| 571 |
+
"properties": {
|
| 572 |
+
"threshold": {
|
| 573 |
+
"description": "Represents the threshold below which the actual value falls.",
|
| 574 |
+
"format": "int64",
|
| 575 |
+
"type": "string"
|
| 576 |
+
},
|
| 577 |
+
"value": {
|
| 578 |
+
"description": "Represents the actual value.",
|
| 579 |
+
"format": "int64",
|
| 580 |
+
"type": "string"
|
| 581 |
+
}
|
| 582 |
+
},
|
| 583 |
+
"type": "object"
|
| 584 |
+
},
|
| 585 |
+
"ListSearchKeywordImpressionsMonthlyResponse": {
|
| 586 |
+
"description": "Represents the response for ListSearchKeywordImpressionsMonthly.",
|
| 587 |
+
"id": "ListSearchKeywordImpressionsMonthlyResponse",
|
| 588 |
+
"properties": {
|
| 589 |
+
"nextPageToken": {
|
| 590 |
+
"description": "A token indicating the last paginated result returned. This can be used by succeeding requests to get the next \"page\" of keywords. It will only be present when there are more results to be returned.",
|
| 591 |
+
"format": "byte",
|
| 592 |
+
"type": "string"
|
| 593 |
+
},
|
| 594 |
+
"searchKeywordsCounts": {
|
| 595 |
+
"description": "Search terms which have been used to find a business.",
|
| 596 |
+
"items": {
|
| 597 |
+
"$ref": "SearchKeywordCount"
|
| 598 |
+
},
|
| 599 |
+
"type": "array"
|
| 600 |
+
}
|
| 601 |
+
},
|
| 602 |
+
"type": "object"
|
| 603 |
+
},
|
| 604 |
+
"MultiDailyMetricTimeSeries": {
|
| 605 |
+
"description": "Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.",
|
| 606 |
+
"id": "MultiDailyMetricTimeSeries",
|
| 607 |
+
"properties": {
|
| 608 |
+
"dailyMetricTimeSeries": {
|
| 609 |
+
"description": "List of DailyMetric-TimeSeries pairs.",
|
| 610 |
+
"items": {
|
| 611 |
+
"$ref": "DailyMetricTimeSeries"
|
| 612 |
+
},
|
| 613 |
+
"type": "array"
|
| 614 |
+
}
|
| 615 |
+
},
|
| 616 |
+
"type": "object"
|
| 617 |
+
},
|
| 618 |
+
"SearchKeywordCount": {
|
| 619 |
+
"description": "Represents a single search keyword and its value.",
|
| 620 |
+
"id": "SearchKeywordCount",
|
| 621 |
+
"properties": {
|
| 622 |
+
"insightsValue": {
|
| 623 |
+
"$ref": "InsightsValue",
|
| 624 |
+
"description": "One of either: 1) The sum of the number of unique users that used the keyword in a month, aggregated for each month requested. 2) A threshold that indicates that the actual value is below this threshold."
|
| 625 |
+
},
|
| 626 |
+
"searchKeyword": {
|
| 627 |
+
"description": "The lower-cased string that the user entered.",
|
| 628 |
+
"type": "string"
|
| 629 |
+
}
|
| 630 |
+
},
|
| 631 |
+
"type": "object"
|
| 632 |
+
},
|
| 633 |
+
"TimeOfDay": {
|
| 634 |
+
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
|
| 635 |
+
"id": "TimeOfDay",
|
| 636 |
+
"properties": {
|
| 637 |
+
"hours": {
|
| 638 |
+
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
|
| 639 |
+
"format": "int32",
|
| 640 |
+
"type": "integer"
|
| 641 |
+
},
|
| 642 |
+
"minutes": {
|
| 643 |
+
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
|
| 644 |
+
"format": "int32",
|
| 645 |
+
"type": "integer"
|
| 646 |
+
},
|
| 647 |
+
"nanos": {
|
| 648 |
+
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
|
| 649 |
+
"format": "int32",
|
| 650 |
+
"type": "integer"
|
| 651 |
+
},
|
| 652 |
+
"seconds": {
|
| 653 |
+
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
|
| 654 |
+
"format": "int32",
|
| 655 |
+
"type": "integer"
|
| 656 |
+
}
|
| 657 |
+
},
|
| 658 |
+
"type": "object"
|
| 659 |
+
},
|
| 660 |
+
"TimeSeries": {
|
| 661 |
+
"description": "Represents a timeseries.",
|
| 662 |
+
"id": "TimeSeries",
|
| 663 |
+
"properties": {
|
| 664 |
+
"datedValues": {
|
| 665 |
+
"description": "List of datapoints in the timeseries, where each datapoint is a date-value pair.",
|
| 666 |
+
"items": {
|
| 667 |
+
"$ref": "DatedValue"
|
| 668 |
+
},
|
| 669 |
+
"type": "array"
|
| 670 |
+
}
|
| 671 |
+
},
|
| 672 |
+
"type": "object"
|
| 673 |
+
}
|
| 674 |
+
},
|
| 675 |
+
"servicePath": "",
|
| 676 |
+
"title": "Business Profile Performance API",
|
| 677 |
+
"version": "v1",
|
| 678 |
+
"version_module": true
|
| 679 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudasset.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json
ADDED
|
@@ -0,0 +1,1409 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://cloudfunctions.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Cloud Functions",
|
| 15 |
+
"description": "Manages lightweight user-provided functions executed in response to events.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/functions",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "cloudfunctions:v1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://cloudfunctions.mtls.googleapis.com/",
|
| 26 |
+
"name": "cloudfunctions",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"operations": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"get": {
|
| 111 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 112 |
+
"flatPath": "v1/operations/{operationsId}",
|
| 113 |
+
"httpMethod": "GET",
|
| 114 |
+
"id": "cloudfunctions.operations.get",
|
| 115 |
+
"parameterOrder": [
|
| 116 |
+
"name"
|
| 117 |
+
],
|
| 118 |
+
"parameters": {
|
| 119 |
+
"name": {
|
| 120 |
+
"description": "The name of the operation resource.",
|
| 121 |
+
"location": "path",
|
| 122 |
+
"pattern": "^operations/[^/]+$",
|
| 123 |
+
"required": true,
|
| 124 |
+
"type": "string"
|
| 125 |
+
}
|
| 126 |
+
},
|
| 127 |
+
"path": "v1/{+name}",
|
| 128 |
+
"response": {
|
| 129 |
+
"$ref": "Operation"
|
| 130 |
+
},
|
| 131 |
+
"scopes": [
|
| 132 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 133 |
+
]
|
| 134 |
+
},
|
| 135 |
+
"list": {
|
| 136 |
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
| 137 |
+
"flatPath": "v1/operations",
|
| 138 |
+
"httpMethod": "GET",
|
| 139 |
+
"id": "cloudfunctions.operations.list",
|
| 140 |
+
"parameterOrder": [],
|
| 141 |
+
"parameters": {
|
| 142 |
+
"filter": {
|
| 143 |
+
"description": "The standard list filter.",
|
| 144 |
+
"location": "query",
|
| 145 |
+
"type": "string"
|
| 146 |
+
},
|
| 147 |
+
"name": {
|
| 148 |
+
"description": "The name of the operation's parent resource.",
|
| 149 |
+
"location": "query",
|
| 150 |
+
"type": "string"
|
| 151 |
+
},
|
| 152 |
+
"pageSize": {
|
| 153 |
+
"description": "The standard list page size.",
|
| 154 |
+
"format": "int32",
|
| 155 |
+
"location": "query",
|
| 156 |
+
"type": "integer"
|
| 157 |
+
},
|
| 158 |
+
"pageToken": {
|
| 159 |
+
"description": "The standard list page token.",
|
| 160 |
+
"location": "query",
|
| 161 |
+
"type": "string"
|
| 162 |
+
}
|
| 163 |
+
},
|
| 164 |
+
"path": "v1/operations",
|
| 165 |
+
"response": {
|
| 166 |
+
"$ref": "ListOperationsResponse"
|
| 167 |
+
},
|
| 168 |
+
"scopes": [
|
| 169 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 170 |
+
]
|
| 171 |
+
}
|
| 172 |
+
}
|
| 173 |
+
},
|
| 174 |
+
"projects": {
|
| 175 |
+
"resources": {
|
| 176 |
+
"locations": {
|
| 177 |
+
"methods": {
|
| 178 |
+
"list": {
|
| 179 |
+
"description": "Lists information about the supported locations for this service.",
|
| 180 |
+
"flatPath": "v1/projects/{projectsId}/locations",
|
| 181 |
+
"httpMethod": "GET",
|
| 182 |
+
"id": "cloudfunctions.projects.locations.list",
|
| 183 |
+
"parameterOrder": [
|
| 184 |
+
"name"
|
| 185 |
+
],
|
| 186 |
+
"parameters": {
|
| 187 |
+
"filter": {
|
| 188 |
+
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
|
| 189 |
+
"location": "query",
|
| 190 |
+
"type": "string"
|
| 191 |
+
},
|
| 192 |
+
"name": {
|
| 193 |
+
"description": "The resource that owns the locations collection, if applicable.",
|
| 194 |
+
"location": "path",
|
| 195 |
+
"pattern": "^projects/[^/]+$",
|
| 196 |
+
"required": true,
|
| 197 |
+
"type": "string"
|
| 198 |
+
},
|
| 199 |
+
"pageSize": {
|
| 200 |
+
"description": "The maximum number of results to return. If not set, the service selects a default.",
|
| 201 |
+
"format": "int32",
|
| 202 |
+
"location": "query",
|
| 203 |
+
"type": "integer"
|
| 204 |
+
},
|
| 205 |
+
"pageToken": {
|
| 206 |
+
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
|
| 207 |
+
"location": "query",
|
| 208 |
+
"type": "string"
|
| 209 |
+
}
|
| 210 |
+
},
|
| 211 |
+
"path": "v1/{+name}/locations",
|
| 212 |
+
"response": {
|
| 213 |
+
"$ref": "ListLocationsResponse"
|
| 214 |
+
},
|
| 215 |
+
"scopes": [
|
| 216 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 217 |
+
]
|
| 218 |
+
}
|
| 219 |
+
},
|
| 220 |
+
"resources": {
|
| 221 |
+
"functions": {
|
| 222 |
+
"methods": {
|
| 223 |
+
"call": {
|
| 224 |
+
"description": "Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits).",
|
| 225 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
|
| 226 |
+
"httpMethod": "POST",
|
| 227 |
+
"id": "cloudfunctions.projects.locations.functions.call",
|
| 228 |
+
"parameterOrder": [
|
| 229 |
+
"name"
|
| 230 |
+
],
|
| 231 |
+
"parameters": {
|
| 232 |
+
"name": {
|
| 233 |
+
"description": "Required. The name of the function to be called.",
|
| 234 |
+
"location": "path",
|
| 235 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 236 |
+
"required": true,
|
| 237 |
+
"type": "string"
|
| 238 |
+
}
|
| 239 |
+
},
|
| 240 |
+
"path": "v1/{+name}:call",
|
| 241 |
+
"request": {
|
| 242 |
+
"$ref": "CallFunctionRequest"
|
| 243 |
+
},
|
| 244 |
+
"response": {
|
| 245 |
+
"$ref": "CallFunctionResponse"
|
| 246 |
+
},
|
| 247 |
+
"scopes": [
|
| 248 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 249 |
+
]
|
| 250 |
+
},
|
| 251 |
+
"create": {
|
| 252 |
+
"description": "Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.",
|
| 253 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
|
| 254 |
+
"httpMethod": "POST",
|
| 255 |
+
"id": "cloudfunctions.projects.locations.functions.create",
|
| 256 |
+
"parameterOrder": [
|
| 257 |
+
"location"
|
| 258 |
+
],
|
| 259 |
+
"parameters": {
|
| 260 |
+
"location": {
|
| 261 |
+
"description": "Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`",
|
| 262 |
+
"location": "path",
|
| 263 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 264 |
+
"required": true,
|
| 265 |
+
"type": "string"
|
| 266 |
+
}
|
| 267 |
+
},
|
| 268 |
+
"path": "v1/{+location}/functions",
|
| 269 |
+
"request": {
|
| 270 |
+
"$ref": "CloudFunction"
|
| 271 |
+
},
|
| 272 |
+
"response": {
|
| 273 |
+
"$ref": "Operation"
|
| 274 |
+
},
|
| 275 |
+
"scopes": [
|
| 276 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 277 |
+
]
|
| 278 |
+
},
|
| 279 |
+
"delete": {
|
| 280 |
+
"description": "Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.",
|
| 281 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
|
| 282 |
+
"httpMethod": "DELETE",
|
| 283 |
+
"id": "cloudfunctions.projects.locations.functions.delete",
|
| 284 |
+
"parameterOrder": [
|
| 285 |
+
"name"
|
| 286 |
+
],
|
| 287 |
+
"parameters": {
|
| 288 |
+
"name": {
|
| 289 |
+
"description": "Required. The name of the function which should be deleted.",
|
| 290 |
+
"location": "path",
|
| 291 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 292 |
+
"required": true,
|
| 293 |
+
"type": "string"
|
| 294 |
+
}
|
| 295 |
+
},
|
| 296 |
+
"path": "v1/{+name}",
|
| 297 |
+
"response": {
|
| 298 |
+
"$ref": "Operation"
|
| 299 |
+
},
|
| 300 |
+
"scopes": [
|
| 301 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 302 |
+
]
|
| 303 |
+
},
|
| 304 |
+
"generateDownloadUrl": {
|
| 305 |
+
"description": "Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls",
|
| 306 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
|
| 307 |
+
"httpMethod": "POST",
|
| 308 |
+
"id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
|
| 309 |
+
"parameterOrder": [
|
| 310 |
+
"name"
|
| 311 |
+
],
|
| 312 |
+
"parameters": {
|
| 313 |
+
"name": {
|
| 314 |
+
"description": "The name of function for which source code Google Cloud Storage signed URL should be generated.",
|
| 315 |
+
"location": "path",
|
| 316 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 317 |
+
"required": true,
|
| 318 |
+
"type": "string"
|
| 319 |
+
}
|
| 320 |
+
},
|
| 321 |
+
"path": "v1/{+name}:generateDownloadUrl",
|
| 322 |
+
"request": {
|
| 323 |
+
"$ref": "GenerateDownloadUrlRequest"
|
| 324 |
+
},
|
| 325 |
+
"response": {
|
| 326 |
+
"$ref": "GenerateDownloadUrlResponse"
|
| 327 |
+
},
|
| 328 |
+
"scopes": [
|
| 329 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 330 |
+
]
|
| 331 |
+
},
|
| 332 |
+
"generateUploadUrl": {
|
| 333 |
+
"description": "Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,104857600` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`",
|
| 334 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
|
| 335 |
+
"httpMethod": "POST",
|
| 336 |
+
"id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
|
| 337 |
+
"parameterOrder": [
|
| 338 |
+
"parent"
|
| 339 |
+
],
|
| 340 |
+
"parameters": {
|
| 341 |
+
"parent": {
|
| 342 |
+
"description": "The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.",
|
| 343 |
+
"location": "path",
|
| 344 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 345 |
+
"required": true,
|
| 346 |
+
"type": "string"
|
| 347 |
+
}
|
| 348 |
+
},
|
| 349 |
+
"path": "v1/{+parent}/functions:generateUploadUrl",
|
| 350 |
+
"request": {
|
| 351 |
+
"$ref": "GenerateUploadUrlRequest"
|
| 352 |
+
},
|
| 353 |
+
"response": {
|
| 354 |
+
"$ref": "GenerateUploadUrlResponse"
|
| 355 |
+
},
|
| 356 |
+
"scopes": [
|
| 357 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 358 |
+
]
|
| 359 |
+
},
|
| 360 |
+
"get": {
|
| 361 |
+
"description": "Returns a function with the given name from the requested project.",
|
| 362 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
|
| 363 |
+
"httpMethod": "GET",
|
| 364 |
+
"id": "cloudfunctions.projects.locations.functions.get",
|
| 365 |
+
"parameterOrder": [
|
| 366 |
+
"name"
|
| 367 |
+
],
|
| 368 |
+
"parameters": {
|
| 369 |
+
"name": {
|
| 370 |
+
"description": "Required. The name of the function which details should be obtained.",
|
| 371 |
+
"location": "path",
|
| 372 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 373 |
+
"required": true,
|
| 374 |
+
"type": "string"
|
| 375 |
+
},
|
| 376 |
+
"versionId": {
|
| 377 |
+
"description": "Optional. The optional version of the function whose details should be obtained. The version of a 1st Gen function is an integer that starts from 1 and gets incremented on redeployments. Each deployment creates a config version of the underlying function. GCF may keep historical configs for old versions. This field can be specified to fetch the historical configs. Leave it blank or set to 0 to get the latest version of the function.",
|
| 378 |
+
"format": "int64",
|
| 379 |
+
"location": "query",
|
| 380 |
+
"type": "string"
|
| 381 |
+
}
|
| 382 |
+
},
|
| 383 |
+
"path": "v1/{+name}",
|
| 384 |
+
"response": {
|
| 385 |
+
"$ref": "CloudFunction"
|
| 386 |
+
},
|
| 387 |
+
"scopes": [
|
| 388 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 389 |
+
]
|
| 390 |
+
},
|
| 391 |
+
"getIamPolicy": {
|
| 392 |
+
"description": "Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.",
|
| 393 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy",
|
| 394 |
+
"httpMethod": "GET",
|
| 395 |
+
"id": "cloudfunctions.projects.locations.functions.getIamPolicy",
|
| 396 |
+
"parameterOrder": [
|
| 397 |
+
"resource"
|
| 398 |
+
],
|
| 399 |
+
"parameters": {
|
| 400 |
+
"options.requestedPolicyVersion": {
|
| 401 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 402 |
+
"format": "int32",
|
| 403 |
+
"location": "query",
|
| 404 |
+
"type": "integer"
|
| 405 |
+
},
|
| 406 |
+
"resource": {
|
| 407 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 408 |
+
"location": "path",
|
| 409 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 410 |
+
"required": true,
|
| 411 |
+
"type": "string"
|
| 412 |
+
}
|
| 413 |
+
},
|
| 414 |
+
"path": "v1/{+resource}:getIamPolicy",
|
| 415 |
+
"response": {
|
| 416 |
+
"$ref": "Policy"
|
| 417 |
+
},
|
| 418 |
+
"scopes": [
|
| 419 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 420 |
+
]
|
| 421 |
+
},
|
| 422 |
+
"list": {
|
| 423 |
+
"description": "Returns a list of functions that belong to the requested project.",
|
| 424 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
|
| 425 |
+
"httpMethod": "GET",
|
| 426 |
+
"id": "cloudfunctions.projects.locations.functions.list",
|
| 427 |
+
"parameterOrder": [
|
| 428 |
+
"parent"
|
| 429 |
+
],
|
| 430 |
+
"parameters": {
|
| 431 |
+
"pageSize": {
|
| 432 |
+
"description": "Maximum number of functions to return per call.",
|
| 433 |
+
"format": "int32",
|
| 434 |
+
"location": "query",
|
| 435 |
+
"type": "integer"
|
| 436 |
+
},
|
| 437 |
+
"pageToken": {
|
| 438 |
+
"description": "The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.",
|
| 439 |
+
"location": "query",
|
| 440 |
+
"type": "string"
|
| 441 |
+
},
|
| 442 |
+
"parent": {
|
| 443 |
+
"description": "The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use \"-\" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.",
|
| 444 |
+
"location": "path",
|
| 445 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 446 |
+
"required": true,
|
| 447 |
+
"type": "string"
|
| 448 |
+
}
|
| 449 |
+
},
|
| 450 |
+
"path": "v1/{+parent}/functions",
|
| 451 |
+
"response": {
|
| 452 |
+
"$ref": "ListFunctionsResponse"
|
| 453 |
+
},
|
| 454 |
+
"scopes": [
|
| 455 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 456 |
+
]
|
| 457 |
+
},
|
| 458 |
+
"patch": {
|
| 459 |
+
"description": "Updates existing function.",
|
| 460 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
|
| 461 |
+
"httpMethod": "PATCH",
|
| 462 |
+
"id": "cloudfunctions.projects.locations.functions.patch",
|
| 463 |
+
"parameterOrder": [
|
| 464 |
+
"name"
|
| 465 |
+
],
|
| 466 |
+
"parameters": {
|
| 467 |
+
"name": {
|
| 468 |
+
"description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`",
|
| 469 |
+
"location": "path",
|
| 470 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 471 |
+
"required": true,
|
| 472 |
+
"type": "string"
|
| 473 |
+
},
|
| 474 |
+
"updateMask": {
|
| 475 |
+
"description": "Required. The list of fields in `CloudFunction` that have to be updated.",
|
| 476 |
+
"format": "google-fieldmask",
|
| 477 |
+
"location": "query",
|
| 478 |
+
"type": "string"
|
| 479 |
+
}
|
| 480 |
+
},
|
| 481 |
+
"path": "v1/{+name}",
|
| 482 |
+
"request": {
|
| 483 |
+
"$ref": "CloudFunction"
|
| 484 |
+
},
|
| 485 |
+
"response": {
|
| 486 |
+
"$ref": "Operation"
|
| 487 |
+
},
|
| 488 |
+
"scopes": [
|
| 489 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 490 |
+
]
|
| 491 |
+
},
|
| 492 |
+
"setIamPolicy": {
|
| 493 |
+
"description": "Sets the IAM access control policy on the specified function. Replaces any existing policy.",
|
| 494 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy",
|
| 495 |
+
"httpMethod": "POST",
|
| 496 |
+
"id": "cloudfunctions.projects.locations.functions.setIamPolicy",
|
| 497 |
+
"parameterOrder": [
|
| 498 |
+
"resource"
|
| 499 |
+
],
|
| 500 |
+
"parameters": {
|
| 501 |
+
"resource": {
|
| 502 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 503 |
+
"location": "path",
|
| 504 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 505 |
+
"required": true,
|
| 506 |
+
"type": "string"
|
| 507 |
+
}
|
| 508 |
+
},
|
| 509 |
+
"path": "v1/{+resource}:setIamPolicy",
|
| 510 |
+
"request": {
|
| 511 |
+
"$ref": "SetIamPolicyRequest"
|
| 512 |
+
},
|
| 513 |
+
"response": {
|
| 514 |
+
"$ref": "Policy"
|
| 515 |
+
},
|
| 516 |
+
"scopes": [
|
| 517 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 518 |
+
]
|
| 519 |
+
},
|
| 520 |
+
"testIamPermissions": {
|
| 521 |
+
"description": "Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.",
|
| 522 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions",
|
| 523 |
+
"httpMethod": "POST",
|
| 524 |
+
"id": "cloudfunctions.projects.locations.functions.testIamPermissions",
|
| 525 |
+
"parameterOrder": [
|
| 526 |
+
"resource"
|
| 527 |
+
],
|
| 528 |
+
"parameters": {
|
| 529 |
+
"resource": {
|
| 530 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 531 |
+
"location": "path",
|
| 532 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
| 533 |
+
"required": true,
|
| 534 |
+
"type": "string"
|
| 535 |
+
}
|
| 536 |
+
},
|
| 537 |
+
"path": "v1/{+resource}:testIamPermissions",
|
| 538 |
+
"request": {
|
| 539 |
+
"$ref": "TestIamPermissionsRequest"
|
| 540 |
+
},
|
| 541 |
+
"response": {
|
| 542 |
+
"$ref": "TestIamPermissionsResponse"
|
| 543 |
+
},
|
| 544 |
+
"scopes": [
|
| 545 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 546 |
+
]
|
| 547 |
+
}
|
| 548 |
+
}
|
| 549 |
+
}
|
| 550 |
+
}
|
| 551 |
+
}
|
| 552 |
+
}
|
| 553 |
+
}
|
| 554 |
+
},
|
| 555 |
+
"revision": "20250102",
|
| 556 |
+
"rootUrl": "https://cloudfunctions.googleapis.com/",
|
| 557 |
+
"schemas": {
|
| 558 |
+
"AuditConfig": {
|
| 559 |
+
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
|
| 560 |
+
"id": "AuditConfig",
|
| 561 |
+
"properties": {
|
| 562 |
+
"auditLogConfigs": {
|
| 563 |
+
"description": "The configuration for logging of each type of permission.",
|
| 564 |
+
"items": {
|
| 565 |
+
"$ref": "AuditLogConfig"
|
| 566 |
+
},
|
| 567 |
+
"type": "array"
|
| 568 |
+
},
|
| 569 |
+
"service": {
|
| 570 |
+
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
|
| 571 |
+
"type": "string"
|
| 572 |
+
}
|
| 573 |
+
},
|
| 574 |
+
"type": "object"
|
| 575 |
+
},
|
| 576 |
+
"AuditLogConfig": {
|
| 577 |
+
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
|
| 578 |
+
"id": "AuditLogConfig",
|
| 579 |
+
"properties": {
|
| 580 |
+
"exemptedMembers": {
|
| 581 |
+
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
|
| 582 |
+
"items": {
|
| 583 |
+
"type": "string"
|
| 584 |
+
},
|
| 585 |
+
"type": "array"
|
| 586 |
+
},
|
| 587 |
+
"logType": {
|
| 588 |
+
"description": "The log type that this config enables.",
|
| 589 |
+
"enum": [
|
| 590 |
+
"LOG_TYPE_UNSPECIFIED",
|
| 591 |
+
"ADMIN_READ",
|
| 592 |
+
"DATA_WRITE",
|
| 593 |
+
"DATA_READ"
|
| 594 |
+
],
|
| 595 |
+
"enumDescriptions": [
|
| 596 |
+
"Default case. Should never be this.",
|
| 597 |
+
"Admin reads. Example: CloudIAM getIamPolicy",
|
| 598 |
+
"Data writes. Example: CloudSQL Users create",
|
| 599 |
+
"Data reads. Example: CloudSQL Users list"
|
| 600 |
+
],
|
| 601 |
+
"type": "string"
|
| 602 |
+
}
|
| 603 |
+
},
|
| 604 |
+
"type": "object"
|
| 605 |
+
},
|
| 606 |
+
"AutomaticUpdatePolicy": {
|
| 607 |
+
"description": "Security patches are applied automatically to the runtime without requiring the function to be redeployed.",
|
| 608 |
+
"id": "AutomaticUpdatePolicy",
|
| 609 |
+
"properties": {},
|
| 610 |
+
"type": "object"
|
| 611 |
+
},
|
| 612 |
+
"Binding": {
|
| 613 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 614 |
+
"id": "Binding",
|
| 615 |
+
"properties": {
|
| 616 |
+
"condition": {
|
| 617 |
+
"$ref": "Expr",
|
| 618 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 619 |
+
},
|
| 620 |
+
"members": {
|
| 621 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 622 |
+
"items": {
|
| 623 |
+
"type": "string"
|
| 624 |
+
},
|
| 625 |
+
"type": "array"
|
| 626 |
+
},
|
| 627 |
+
"role": {
|
| 628 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 629 |
+
"type": "string"
|
| 630 |
+
}
|
| 631 |
+
},
|
| 632 |
+
"type": "object"
|
| 633 |
+
},
|
| 634 |
+
"CallFunctionRequest": {
|
| 635 |
+
"description": "Request for the `CallFunction` method.",
|
| 636 |
+
"id": "CallFunctionRequest",
|
| 637 |
+
"properties": {
|
| 638 |
+
"data": {
|
| 639 |
+
"description": "Required. Input to be passed to the function.",
|
| 640 |
+
"type": "string"
|
| 641 |
+
}
|
| 642 |
+
},
|
| 643 |
+
"type": "object"
|
| 644 |
+
},
|
| 645 |
+
"CallFunctionResponse": {
|
| 646 |
+
"description": "Response of `CallFunction` method.",
|
| 647 |
+
"id": "CallFunctionResponse",
|
| 648 |
+
"properties": {
|
| 649 |
+
"error": {
|
| 650 |
+
"description": "Either system or user-function generated error. Set if execution was not successful.",
|
| 651 |
+
"type": "string"
|
| 652 |
+
},
|
| 653 |
+
"executionId": {
|
| 654 |
+
"description": "Execution id of function invocation.",
|
| 655 |
+
"type": "string"
|
| 656 |
+
},
|
| 657 |
+
"result": {
|
| 658 |
+
"description": "Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.",
|
| 659 |
+
"type": "string"
|
| 660 |
+
}
|
| 661 |
+
},
|
| 662 |
+
"type": "object"
|
| 663 |
+
},
|
| 664 |
+
"CloudFunction": {
|
| 665 |
+
"description": "Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.",
|
| 666 |
+
"id": "CloudFunction",
|
| 667 |
+
"properties": {
|
| 668 |
+
"automaticUpdatePolicy": {
|
| 669 |
+
"$ref": "AutomaticUpdatePolicy"
|
| 670 |
+
},
|
| 671 |
+
"availableMemoryMb": {
|
| 672 |
+
"description": "The amount of memory in MB available for a function. Defaults to 256MB.",
|
| 673 |
+
"format": "int32",
|
| 674 |
+
"type": "integer"
|
| 675 |
+
},
|
| 676 |
+
"buildEnvironmentVariables": {
|
| 677 |
+
"additionalProperties": {
|
| 678 |
+
"type": "string"
|
| 679 |
+
},
|
| 680 |
+
"description": "Build environment variables that shall be available during build time.",
|
| 681 |
+
"type": "object"
|
| 682 |
+
},
|
| 683 |
+
"buildId": {
|
| 684 |
+
"description": "Output only. The Cloud Build ID of the latest successful deployment of the function.",
|
| 685 |
+
"readOnly": true,
|
| 686 |
+
"type": "string"
|
| 687 |
+
},
|
| 688 |
+
"buildName": {
|
| 689 |
+
"description": "Output only. The Cloud Build Name of the function deployment. `projects//locations//builds/`.",
|
| 690 |
+
"readOnly": true,
|
| 691 |
+
"type": "string"
|
| 692 |
+
},
|
| 693 |
+
"buildServiceAccount": {
|
| 694 |
+
"description": "A service account the user provides for use with Cloud Build. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.",
|
| 695 |
+
"type": "string"
|
| 696 |
+
},
|
| 697 |
+
"buildWorkerPool": {
|
| 698 |
+
"description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (`service-@gcf-admin-robot.iam.gserviceaccount.com`) must be granted the role Cloud Build Custom Workers Builder (`roles/cloudbuild.customworkers.builder`) in the project.",
|
| 699 |
+
"type": "string"
|
| 700 |
+
},
|
| 701 |
+
"description": {
|
| 702 |
+
"description": "User-provided description of a function.",
|
| 703 |
+
"type": "string"
|
| 704 |
+
},
|
| 705 |
+
"dockerRegistry": {
|
| 706 |
+
"deprecated": true,
|
| 707 |
+
"description": "Docker Registry to use for this deployment. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.",
|
| 708 |
+
"enum": [
|
| 709 |
+
"DOCKER_REGISTRY_UNSPECIFIED",
|
| 710 |
+
"CONTAINER_REGISTRY",
|
| 711 |
+
"ARTIFACT_REGISTRY"
|
| 712 |
+
],
|
| 713 |
+
"enumDescriptions": [
|
| 714 |
+
"Unspecified.",
|
| 715 |
+
"Docker images will be stored in multi-regional Container Registry repositories named `gcf`.",
|
| 716 |
+
"Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named `gcf-artifacts` in every region in which a function is deployed. But the repository to use can also be specified by the user using the `docker_repository` field."
|
| 717 |
+
],
|
| 718 |
+
"type": "string"
|
| 719 |
+
},
|
| 720 |
+
"dockerRepository": {
|
| 721 |
+
"description": "User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and `docker_registry` is not explicitly set to `CONTAINER_REGISTRY`, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.",
|
| 722 |
+
"type": "string"
|
| 723 |
+
},
|
| 724 |
+
"entryPoint": {
|
| 725 |
+
"description": "The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.",
|
| 726 |
+
"type": "string"
|
| 727 |
+
},
|
| 728 |
+
"environmentVariables": {
|
| 729 |
+
"additionalProperties": {
|
| 730 |
+
"type": "string"
|
| 731 |
+
},
|
| 732 |
+
"description": "Environment variables that shall be available during function execution.",
|
| 733 |
+
"type": "object"
|
| 734 |
+
},
|
| 735 |
+
"eventTrigger": {
|
| 736 |
+
"$ref": "EventTrigger",
|
| 737 |
+
"description": "A source that fires events in response to a condition in another service."
|
| 738 |
+
},
|
| 739 |
+
"httpsTrigger": {
|
| 740 |
+
"$ref": "HttpsTrigger",
|
| 741 |
+
"description": "An HTTPS endpoint type of source that can be triggered via URL."
|
| 742 |
+
},
|
| 743 |
+
"ingressSettings": {
|
| 744 |
+
"description": "The ingress settings for the function, controlling what traffic can reach it.",
|
| 745 |
+
"enum": [
|
| 746 |
+
"INGRESS_SETTINGS_UNSPECIFIED",
|
| 747 |
+
"ALLOW_ALL",
|
| 748 |
+
"ALLOW_INTERNAL_ONLY",
|
| 749 |
+
"ALLOW_INTERNAL_AND_GCLB"
|
| 750 |
+
],
|
| 751 |
+
"enumDescriptions": [
|
| 752 |
+
"Unspecified.",
|
| 753 |
+
"Allow HTTP traffic from public and private sources.",
|
| 754 |
+
"Allow HTTP traffic from only private VPC sources.",
|
| 755 |
+
"Allow HTTP traffic from private VPC sources and through GCLB."
|
| 756 |
+
],
|
| 757 |
+
"type": "string"
|
| 758 |
+
},
|
| 759 |
+
"kmsKeyName": {
|
| 760 |
+
"description": "Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. If specified, you must also provide an artifact registry repository using the `docker_repository` field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.",
|
| 761 |
+
"type": "string"
|
| 762 |
+
},
|
| 763 |
+
"labels": {
|
| 764 |
+
"additionalProperties": {
|
| 765 |
+
"type": "string"
|
| 766 |
+
},
|
| 767 |
+
"description": "Labels associated with this Cloud Function.",
|
| 768 |
+
"type": "object"
|
| 769 |
+
},
|
| 770 |
+
"maxInstances": {
|
| 771 |
+
"description": "The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.",
|
| 772 |
+
"format": "int32",
|
| 773 |
+
"type": "integer"
|
| 774 |
+
},
|
| 775 |
+
"minInstances": {
|
| 776 |
+
"description": "A lower bound for the number function instances that may coexist at a given time.",
|
| 777 |
+
"format": "int32",
|
| 778 |
+
"type": "integer"
|
| 779 |
+
},
|
| 780 |
+
"name": {
|
| 781 |
+
"description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`",
|
| 782 |
+
"type": "string"
|
| 783 |
+
},
|
| 784 |
+
"network": {
|
| 785 |
+
"deprecated": true,
|
| 786 |
+
"description": "Deprecated: use vpc_connector",
|
| 787 |
+
"type": "string"
|
| 788 |
+
},
|
| 789 |
+
"onDeployUpdatePolicy": {
|
| 790 |
+
"$ref": "OnDeployUpdatePolicy"
|
| 791 |
+
},
|
| 792 |
+
"runtime": {
|
| 793 |
+
"description": "The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).",
|
| 794 |
+
"type": "string"
|
| 795 |
+
},
|
| 796 |
+
"secretEnvironmentVariables": {
|
| 797 |
+
"description": "Secret environment variables configuration.",
|
| 798 |
+
"items": {
|
| 799 |
+
"$ref": "SecretEnvVar"
|
| 800 |
+
},
|
| 801 |
+
"type": "array"
|
| 802 |
+
},
|
| 803 |
+
"secretVolumes": {
|
| 804 |
+
"description": "Secret volumes configuration.",
|
| 805 |
+
"items": {
|
| 806 |
+
"$ref": "SecretVolume"
|
| 807 |
+
},
|
| 808 |
+
"type": "array"
|
| 809 |
+
},
|
| 810 |
+
"serviceAccountEmail": {
|
| 811 |
+
"description": "The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`.",
|
| 812 |
+
"type": "string"
|
| 813 |
+
},
|
| 814 |
+
"sourceArchiveUrl": {
|
| 815 |
+
"description": "The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.",
|
| 816 |
+
"type": "string"
|
| 817 |
+
},
|
| 818 |
+
"sourceRepository": {
|
| 819 |
+
"$ref": "SourceRepository",
|
| 820 |
+
"description": "**Beta Feature** The source repository where a function is hosted."
|
| 821 |
+
},
|
| 822 |
+
"sourceToken": {
|
| 823 |
+
"description": "Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.",
|
| 824 |
+
"type": "string"
|
| 825 |
+
},
|
| 826 |
+
"sourceUploadUrl": {
|
| 827 |
+
"description": "The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)",
|
| 828 |
+
"type": "string"
|
| 829 |
+
},
|
| 830 |
+
"status": {
|
| 831 |
+
"description": "Output only. Status of the function deployment.",
|
| 832 |
+
"enum": [
|
| 833 |
+
"CLOUD_FUNCTION_STATUS_UNSPECIFIED",
|
| 834 |
+
"ACTIVE",
|
| 835 |
+
"OFFLINE",
|
| 836 |
+
"DEPLOY_IN_PROGRESS",
|
| 837 |
+
"DELETE_IN_PROGRESS",
|
| 838 |
+
"UNKNOWN"
|
| 839 |
+
],
|
| 840 |
+
"enumDescriptions": [
|
| 841 |
+
"Not specified. Invalid state.",
|
| 842 |
+
"Function has been successfully deployed and is serving.",
|
| 843 |
+
"Function deployment failed and the function isn\u2019t serving.",
|
| 844 |
+
"Function is being created or updated.",
|
| 845 |
+
"Function is being deleted.",
|
| 846 |
+
"Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state."
|
| 847 |
+
],
|
| 848 |
+
"readOnly": true,
|
| 849 |
+
"type": "string"
|
| 850 |
+
},
|
| 851 |
+
"timeout": {
|
| 852 |
+
"description": "The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.",
|
| 853 |
+
"format": "google-duration",
|
| 854 |
+
"type": "string"
|
| 855 |
+
},
|
| 856 |
+
"updateTime": {
|
| 857 |
+
"description": "Output only. The last update timestamp of a Cloud Function.",
|
| 858 |
+
"format": "google-datetime",
|
| 859 |
+
"readOnly": true,
|
| 860 |
+
"type": "string"
|
| 861 |
+
},
|
| 862 |
+
"versionId": {
|
| 863 |
+
"description": "Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.",
|
| 864 |
+
"format": "int64",
|
| 865 |
+
"readOnly": true,
|
| 866 |
+
"type": "string"
|
| 867 |
+
},
|
| 868 |
+
"vpcConnector": {
|
| 869 |
+
"description": "The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/*/locations/*/connectors/*` This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.",
|
| 870 |
+
"type": "string"
|
| 871 |
+
},
|
| 872 |
+
"vpcConnectorEgressSettings": {
|
| 873 |
+
"description": "The egress settings for the connector, controlling what traffic is diverted through it.",
|
| 874 |
+
"enum": [
|
| 875 |
+
"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED",
|
| 876 |
+
"PRIVATE_RANGES_ONLY",
|
| 877 |
+
"ALL_TRAFFIC"
|
| 878 |
+
],
|
| 879 |
+
"enumDescriptions": [
|
| 880 |
+
"Unspecified.",
|
| 881 |
+
"Use the VPC Access Connector only for private IP space from RFC1918.",
|
| 882 |
+
"Force the use of VPC Access Connector for all egress traffic from the function."
|
| 883 |
+
],
|
| 884 |
+
"type": "string"
|
| 885 |
+
}
|
| 886 |
+
},
|
| 887 |
+
"type": "object"
|
| 888 |
+
},
|
| 889 |
+
"EventTrigger": {
|
| 890 |
+
"description": "Describes EventTrigger, used to request events be sent from another service.",
|
| 891 |
+
"id": "EventTrigger",
|
| 892 |
+
"properties": {
|
| 893 |
+
"eventType": {
|
| 894 |
+
"description": "Required. The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match pattern `providers/*/eventTypes/*.*`. The pattern contains: 1. namespace: For example, `cloud.storage` and `google.firebase.analytics`. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type `object`. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.",
|
| 895 |
+
"type": "string"
|
| 896 |
+
},
|
| 897 |
+
"failurePolicy": {
|
| 898 |
+
"$ref": "FailurePolicy",
|
| 899 |
+
"description": "Specifies policy for failed executions."
|
| 900 |
+
},
|
| 901 |
+
"resource": {
|
| 902 |
+
"description": "Required. The resource(s) from which to observe events, for example, `projects/_/buckets/myBucket`. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the `CloudFunction`. 2. The resource type must match the pattern expected for an `event_type`. For example, an `EventTrigger` that has an `event_type` of \"google.pubsub.topic.publish\" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an `EventTrigger`. These will always be returned in the normalized \"long\" format. See each *service's* documentation for supported formats.",
|
| 903 |
+
"type": "string"
|
| 904 |
+
},
|
| 905 |
+
"service": {
|
| 906 |
+
"description": "The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace.",
|
| 907 |
+
"type": "string"
|
| 908 |
+
}
|
| 909 |
+
},
|
| 910 |
+
"type": "object"
|
| 911 |
+
},
|
| 912 |
+
"Expr": {
|
| 913 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 914 |
+
"id": "Expr",
|
| 915 |
+
"properties": {
|
| 916 |
+
"description": {
|
| 917 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 918 |
+
"type": "string"
|
| 919 |
+
},
|
| 920 |
+
"expression": {
|
| 921 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 922 |
+
"type": "string"
|
| 923 |
+
},
|
| 924 |
+
"location": {
|
| 925 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 926 |
+
"type": "string"
|
| 927 |
+
},
|
| 928 |
+
"title": {
|
| 929 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 930 |
+
"type": "string"
|
| 931 |
+
}
|
| 932 |
+
},
|
| 933 |
+
"type": "object"
|
| 934 |
+
},
|
| 935 |
+
"FailurePolicy": {
|
| 936 |
+
"description": "Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).",
|
| 937 |
+
"id": "FailurePolicy",
|
| 938 |
+
"properties": {
|
| 939 |
+
"retry": {
|
| 940 |
+
"$ref": "Retry",
|
| 941 |
+
"description": "If specified, then the function will be retried in case of a failure."
|
| 942 |
+
}
|
| 943 |
+
},
|
| 944 |
+
"type": "object"
|
| 945 |
+
},
|
| 946 |
+
"GenerateDownloadUrlRequest": {
|
| 947 |
+
"description": "Request of `GenerateDownloadUrl` method.",
|
| 948 |
+
"id": "GenerateDownloadUrlRequest",
|
| 949 |
+
"properties": {
|
| 950 |
+
"versionId": {
|
| 951 |
+
"description": "The optional version of function. If not set, default, current version is used.",
|
| 952 |
+
"format": "uint64",
|
| 953 |
+
"type": "string"
|
| 954 |
+
}
|
| 955 |
+
},
|
| 956 |
+
"type": "object"
|
| 957 |
+
},
|
| 958 |
+
"GenerateDownloadUrlResponse": {
|
| 959 |
+
"description": "Response of `GenerateDownloadUrl` method.",
|
| 960 |
+
"id": "GenerateDownloadUrlResponse",
|
| 961 |
+
"properties": {
|
| 962 |
+
"downloadUrl": {
|
| 963 |
+
"description": "The generated Google Cloud Storage signed URL that should be used for function source code download.",
|
| 964 |
+
"type": "string"
|
| 965 |
+
}
|
| 966 |
+
},
|
| 967 |
+
"type": "object"
|
| 968 |
+
},
|
| 969 |
+
"GenerateUploadUrlRequest": {
|
| 970 |
+
"description": "Request of `GenerateSourceUploadUrl` method.",
|
| 971 |
+
"id": "GenerateUploadUrlRequest",
|
| 972 |
+
"properties": {
|
| 973 |
+
"kmsKeyName": {
|
| 974 |
+
"description": "Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). GCF will delegate access to the Google Storage service account in the internal project.",
|
| 975 |
+
"type": "string"
|
| 976 |
+
}
|
| 977 |
+
},
|
| 978 |
+
"type": "object"
|
| 979 |
+
},
|
| 980 |
+
"GenerateUploadUrlResponse": {
|
| 981 |
+
"description": "Response of `GenerateSourceUploadUrl` method.",
|
| 982 |
+
"id": "GenerateUploadUrlResponse",
|
| 983 |
+
"properties": {
|
| 984 |
+
"uploadUrl": {
|
| 985 |
+
"description": "The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.",
|
| 986 |
+
"type": "string"
|
| 987 |
+
}
|
| 988 |
+
},
|
| 989 |
+
"type": "object"
|
| 990 |
+
},
|
| 991 |
+
"HttpsTrigger": {
|
| 992 |
+
"description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
|
| 993 |
+
"id": "HttpsTrigger",
|
| 994 |
+
"properties": {
|
| 995 |
+
"securityLevel": {
|
| 996 |
+
"description": "The security level for the function.",
|
| 997 |
+
"enum": [
|
| 998 |
+
"SECURITY_LEVEL_UNSPECIFIED",
|
| 999 |
+
"SECURE_ALWAYS",
|
| 1000 |
+
"SECURE_OPTIONAL"
|
| 1001 |
+
],
|
| 1002 |
+
"enumDescriptions": [
|
| 1003 |
+
"Unspecified.",
|
| 1004 |
+
"Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.",
|
| 1005 |
+
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly."
|
| 1006 |
+
],
|
| 1007 |
+
"type": "string"
|
| 1008 |
+
},
|
| 1009 |
+
"url": {
|
| 1010 |
+
"description": "Output only. The deployed url for the function.",
|
| 1011 |
+
"readOnly": true,
|
| 1012 |
+
"type": "string"
|
| 1013 |
+
}
|
| 1014 |
+
},
|
| 1015 |
+
"type": "object"
|
| 1016 |
+
},
|
| 1017 |
+
"ListFunctionsResponse": {
|
| 1018 |
+
"description": "Response for the `ListFunctions` method.",
|
| 1019 |
+
"id": "ListFunctionsResponse",
|
| 1020 |
+
"properties": {
|
| 1021 |
+
"functions": {
|
| 1022 |
+
"description": "The functions that match the request.",
|
| 1023 |
+
"items": {
|
| 1024 |
+
"$ref": "CloudFunction"
|
| 1025 |
+
},
|
| 1026 |
+
"type": "array"
|
| 1027 |
+
},
|
| 1028 |
+
"nextPageToken": {
|
| 1029 |
+
"description": "If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1.ListFunctionsRequest to get more functions.",
|
| 1030 |
+
"type": "string"
|
| 1031 |
+
},
|
| 1032 |
+
"unreachable": {
|
| 1033 |
+
"description": "Locations that could not be reached. The response does not include any functions from these locations.",
|
| 1034 |
+
"items": {
|
| 1035 |
+
"type": "string"
|
| 1036 |
+
},
|
| 1037 |
+
"type": "array"
|
| 1038 |
+
}
|
| 1039 |
+
},
|
| 1040 |
+
"type": "object"
|
| 1041 |
+
},
|
| 1042 |
+
"ListLocationsResponse": {
|
| 1043 |
+
"description": "The response message for Locations.ListLocations.",
|
| 1044 |
+
"id": "ListLocationsResponse",
|
| 1045 |
+
"properties": {
|
| 1046 |
+
"locations": {
|
| 1047 |
+
"description": "A list of locations that matches the specified filter in the request.",
|
| 1048 |
+
"items": {
|
| 1049 |
+
"$ref": "Location"
|
| 1050 |
+
},
|
| 1051 |
+
"type": "array"
|
| 1052 |
+
},
|
| 1053 |
+
"nextPageToken": {
|
| 1054 |
+
"description": "The standard List next-page token.",
|
| 1055 |
+
"type": "string"
|
| 1056 |
+
}
|
| 1057 |
+
},
|
| 1058 |
+
"type": "object"
|
| 1059 |
+
},
|
| 1060 |
+
"ListOperationsResponse": {
|
| 1061 |
+
"description": "The response message for Operations.ListOperations.",
|
| 1062 |
+
"id": "ListOperationsResponse",
|
| 1063 |
+
"properties": {
|
| 1064 |
+
"nextPageToken": {
|
| 1065 |
+
"description": "The standard List next-page token.",
|
| 1066 |
+
"type": "string"
|
| 1067 |
+
},
|
| 1068 |
+
"operations": {
|
| 1069 |
+
"description": "A list of operations that matches the specified filter in the request.",
|
| 1070 |
+
"items": {
|
| 1071 |
+
"$ref": "Operation"
|
| 1072 |
+
},
|
| 1073 |
+
"type": "array"
|
| 1074 |
+
}
|
| 1075 |
+
},
|
| 1076 |
+
"type": "object"
|
| 1077 |
+
},
|
| 1078 |
+
"Location": {
|
| 1079 |
+
"description": "A resource that represents a Google Cloud location.",
|
| 1080 |
+
"id": "Location",
|
| 1081 |
+
"properties": {
|
| 1082 |
+
"displayName": {
|
| 1083 |
+
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
|
| 1084 |
+
"type": "string"
|
| 1085 |
+
},
|
| 1086 |
+
"labels": {
|
| 1087 |
+
"additionalProperties": {
|
| 1088 |
+
"type": "string"
|
| 1089 |
+
},
|
| 1090 |
+
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
|
| 1091 |
+
"type": "object"
|
| 1092 |
+
},
|
| 1093 |
+
"locationId": {
|
| 1094 |
+
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
|
| 1095 |
+
"type": "string"
|
| 1096 |
+
},
|
| 1097 |
+
"metadata": {
|
| 1098 |
+
"additionalProperties": {
|
| 1099 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1100 |
+
"type": "any"
|
| 1101 |
+
},
|
| 1102 |
+
"description": "Service-specific metadata. For example the available capacity at the given location.",
|
| 1103 |
+
"type": "object"
|
| 1104 |
+
},
|
| 1105 |
+
"name": {
|
| 1106 |
+
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
|
| 1107 |
+
"type": "string"
|
| 1108 |
+
}
|
| 1109 |
+
},
|
| 1110 |
+
"type": "object"
|
| 1111 |
+
},
|
| 1112 |
+
"OnDeployUpdatePolicy": {
|
| 1113 |
+
"description": "Security patches are only applied when a function is redeployed.",
|
| 1114 |
+
"id": "OnDeployUpdatePolicy",
|
| 1115 |
+
"properties": {
|
| 1116 |
+
"runtimeVersion": {
|
| 1117 |
+
"description": "Output only. Contains the runtime version which was used during latest function deployment.",
|
| 1118 |
+
"readOnly": true,
|
| 1119 |
+
"type": "string"
|
| 1120 |
+
}
|
| 1121 |
+
},
|
| 1122 |
+
"type": "object"
|
| 1123 |
+
},
|
| 1124 |
+
"Operation": {
|
| 1125 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 1126 |
+
"id": "Operation",
|
| 1127 |
+
"properties": {
|
| 1128 |
+
"done": {
|
| 1129 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 1130 |
+
"type": "boolean"
|
| 1131 |
+
},
|
| 1132 |
+
"error": {
|
| 1133 |
+
"$ref": "Status",
|
| 1134 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 1135 |
+
},
|
| 1136 |
+
"metadata": {
|
| 1137 |
+
"additionalProperties": {
|
| 1138 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1139 |
+
"type": "any"
|
| 1140 |
+
},
|
| 1141 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 1142 |
+
"type": "object"
|
| 1143 |
+
},
|
| 1144 |
+
"name": {
|
| 1145 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 1146 |
+
"type": "string"
|
| 1147 |
+
},
|
| 1148 |
+
"response": {
|
| 1149 |
+
"additionalProperties": {
|
| 1150 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1151 |
+
"type": "any"
|
| 1152 |
+
},
|
| 1153 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 1154 |
+
"type": "object"
|
| 1155 |
+
}
|
| 1156 |
+
},
|
| 1157 |
+
"type": "object"
|
| 1158 |
+
},
|
| 1159 |
+
"OperationMetadataV1": {
|
| 1160 |
+
"description": "Metadata describing an Operation",
|
| 1161 |
+
"id": "OperationMetadataV1",
|
| 1162 |
+
"properties": {
|
| 1163 |
+
"buildId": {
|
| 1164 |
+
"description": "The Cloud Build ID of the function created or updated by an API call. This field is only populated for Create and Update operations.",
|
| 1165 |
+
"type": "string"
|
| 1166 |
+
},
|
| 1167 |
+
"buildName": {
|
| 1168 |
+
"description": "The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. `projects//locations//builds/`.",
|
| 1169 |
+
"type": "string"
|
| 1170 |
+
},
|
| 1171 |
+
"request": {
|
| 1172 |
+
"additionalProperties": {
|
| 1173 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1174 |
+
"type": "any"
|
| 1175 |
+
},
|
| 1176 |
+
"description": "The original request that started the operation.",
|
| 1177 |
+
"type": "object"
|
| 1178 |
+
},
|
| 1179 |
+
"sourceToken": {
|
| 1180 |
+
"description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.",
|
| 1181 |
+
"type": "string"
|
| 1182 |
+
},
|
| 1183 |
+
"target": {
|
| 1184 |
+
"description": "Target of the operation - for example `projects/project-1/locations/region-1/functions/function-1`",
|
| 1185 |
+
"type": "string"
|
| 1186 |
+
},
|
| 1187 |
+
"type": {
|
| 1188 |
+
"description": "Type of operation.",
|
| 1189 |
+
"enum": [
|
| 1190 |
+
"OPERATION_UNSPECIFIED",
|
| 1191 |
+
"CREATE_FUNCTION",
|
| 1192 |
+
"UPDATE_FUNCTION",
|
| 1193 |
+
"DELETE_FUNCTION"
|
| 1194 |
+
],
|
| 1195 |
+
"enumDescriptions": [
|
| 1196 |
+
"Unknown operation type.",
|
| 1197 |
+
"Triggered by CreateFunction call",
|
| 1198 |
+
"Triggered by UpdateFunction call",
|
| 1199 |
+
"Triggered by DeleteFunction call."
|
| 1200 |
+
],
|
| 1201 |
+
"type": "string"
|
| 1202 |
+
},
|
| 1203 |
+
"updateTime": {
|
| 1204 |
+
"description": "The last update timestamp of the operation.",
|
| 1205 |
+
"format": "google-datetime",
|
| 1206 |
+
"type": "string"
|
| 1207 |
+
},
|
| 1208 |
+
"versionId": {
|
| 1209 |
+
"description": "Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.",
|
| 1210 |
+
"format": "int64",
|
| 1211 |
+
"type": "string"
|
| 1212 |
+
}
|
| 1213 |
+
},
|
| 1214 |
+
"type": "object"
|
| 1215 |
+
},
|
| 1216 |
+
"Policy": {
|
| 1217 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 1218 |
+
"id": "Policy",
|
| 1219 |
+
"properties": {
|
| 1220 |
+
"auditConfigs": {
|
| 1221 |
+
"description": "Specifies cloud audit logging configuration for this policy.",
|
| 1222 |
+
"items": {
|
| 1223 |
+
"$ref": "AuditConfig"
|
| 1224 |
+
},
|
| 1225 |
+
"type": "array"
|
| 1226 |
+
},
|
| 1227 |
+
"bindings": {
|
| 1228 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 1229 |
+
"items": {
|
| 1230 |
+
"$ref": "Binding"
|
| 1231 |
+
},
|
| 1232 |
+
"type": "array"
|
| 1233 |
+
},
|
| 1234 |
+
"etag": {
|
| 1235 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 1236 |
+
"format": "byte",
|
| 1237 |
+
"type": "string"
|
| 1238 |
+
},
|
| 1239 |
+
"version": {
|
| 1240 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 1241 |
+
"format": "int32",
|
| 1242 |
+
"type": "integer"
|
| 1243 |
+
}
|
| 1244 |
+
},
|
| 1245 |
+
"type": "object"
|
| 1246 |
+
},
|
| 1247 |
+
"Retry": {
|
| 1248 |
+
"description": "Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.",
|
| 1249 |
+
"id": "Retry",
|
| 1250 |
+
"properties": {},
|
| 1251 |
+
"type": "object"
|
| 1252 |
+
},
|
| 1253 |
+
"SecretEnvVar": {
|
| 1254 |
+
"description": "Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.",
|
| 1255 |
+
"id": "SecretEnvVar",
|
| 1256 |
+
"properties": {
|
| 1257 |
+
"key": {
|
| 1258 |
+
"description": "Name of the environment variable.",
|
| 1259 |
+
"type": "string"
|
| 1260 |
+
},
|
| 1261 |
+
"projectId": {
|
| 1262 |
+
"description": "Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.",
|
| 1263 |
+
"type": "string"
|
| 1264 |
+
},
|
| 1265 |
+
"secret": {
|
| 1266 |
+
"description": "Name of the secret in secret manager (not the full resource name).",
|
| 1267 |
+
"type": "string"
|
| 1268 |
+
},
|
| 1269 |
+
"version": {
|
| 1270 |
+
"description": "Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.",
|
| 1271 |
+
"type": "string"
|
| 1272 |
+
}
|
| 1273 |
+
},
|
| 1274 |
+
"type": "object"
|
| 1275 |
+
},
|
| 1276 |
+
"SecretVersion": {
|
| 1277 |
+
"description": "Configuration for a single version.",
|
| 1278 |
+
"id": "SecretVersion",
|
| 1279 |
+
"properties": {
|
| 1280 |
+
"path": {
|
| 1281 |
+
"description": "Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `/secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.",
|
| 1282 |
+
"type": "string"
|
| 1283 |
+
},
|
| 1284 |
+
"version": {
|
| 1285 |
+
"description": "Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.",
|
| 1286 |
+
"type": "string"
|
| 1287 |
+
}
|
| 1288 |
+
},
|
| 1289 |
+
"type": "object"
|
| 1290 |
+
},
|
| 1291 |
+
"SecretVolume": {
|
| 1292 |
+
"description": "Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.",
|
| 1293 |
+
"id": "SecretVolume",
|
| 1294 |
+
"properties": {
|
| 1295 |
+
"mountPath": {
|
| 1296 |
+
"description": "The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log",
|
| 1297 |
+
"type": "string"
|
| 1298 |
+
},
|
| 1299 |
+
"projectId": {
|
| 1300 |
+
"description": "Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.",
|
| 1301 |
+
"type": "string"
|
| 1302 |
+
},
|
| 1303 |
+
"secret": {
|
| 1304 |
+
"description": "Name of the secret in secret manager (not the full resource name).",
|
| 1305 |
+
"type": "string"
|
| 1306 |
+
},
|
| 1307 |
+
"versions": {
|
| 1308 |
+
"description": "List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.",
|
| 1309 |
+
"items": {
|
| 1310 |
+
"$ref": "SecretVersion"
|
| 1311 |
+
},
|
| 1312 |
+
"type": "array"
|
| 1313 |
+
}
|
| 1314 |
+
},
|
| 1315 |
+
"type": "object"
|
| 1316 |
+
},
|
| 1317 |
+
"SetIamPolicyRequest": {
|
| 1318 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 1319 |
+
"id": "SetIamPolicyRequest",
|
| 1320 |
+
"properties": {
|
| 1321 |
+
"policy": {
|
| 1322 |
+
"$ref": "Policy",
|
| 1323 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 1324 |
+
},
|
| 1325 |
+
"updateMask": {
|
| 1326 |
+
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
|
| 1327 |
+
"format": "google-fieldmask",
|
| 1328 |
+
"type": "string"
|
| 1329 |
+
}
|
| 1330 |
+
},
|
| 1331 |
+
"type": "object"
|
| 1332 |
+
},
|
| 1333 |
+
"SourceRepository": {
|
| 1334 |
+
"description": "Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.",
|
| 1335 |
+
"id": "SourceRepository",
|
| 1336 |
+
"properties": {
|
| 1337 |
+
"deployedUrl": {
|
| 1338 |
+
"description": "Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.",
|
| 1339 |
+
"readOnly": true,
|
| 1340 |
+
"type": "string"
|
| 1341 |
+
},
|
| 1342 |
+
"url": {
|
| 1343 |
+
"description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.",
|
| 1344 |
+
"type": "string"
|
| 1345 |
+
}
|
| 1346 |
+
},
|
| 1347 |
+
"type": "object"
|
| 1348 |
+
},
|
| 1349 |
+
"Status": {
|
| 1350 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 1351 |
+
"id": "Status",
|
| 1352 |
+
"properties": {
|
| 1353 |
+
"code": {
|
| 1354 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 1355 |
+
"format": "int32",
|
| 1356 |
+
"type": "integer"
|
| 1357 |
+
},
|
| 1358 |
+
"details": {
|
| 1359 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 1360 |
+
"items": {
|
| 1361 |
+
"additionalProperties": {
|
| 1362 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1363 |
+
"type": "any"
|
| 1364 |
+
},
|
| 1365 |
+
"type": "object"
|
| 1366 |
+
},
|
| 1367 |
+
"type": "array"
|
| 1368 |
+
},
|
| 1369 |
+
"message": {
|
| 1370 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 1371 |
+
"type": "string"
|
| 1372 |
+
}
|
| 1373 |
+
},
|
| 1374 |
+
"type": "object"
|
| 1375 |
+
},
|
| 1376 |
+
"TestIamPermissionsRequest": {
|
| 1377 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 1378 |
+
"id": "TestIamPermissionsRequest",
|
| 1379 |
+
"properties": {
|
| 1380 |
+
"permissions": {
|
| 1381 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 1382 |
+
"items": {
|
| 1383 |
+
"type": "string"
|
| 1384 |
+
},
|
| 1385 |
+
"type": "array"
|
| 1386 |
+
}
|
| 1387 |
+
},
|
| 1388 |
+
"type": "object"
|
| 1389 |
+
},
|
| 1390 |
+
"TestIamPermissionsResponse": {
|
| 1391 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 1392 |
+
"id": "TestIamPermissionsResponse",
|
| 1393 |
+
"properties": {
|
| 1394 |
+
"permissions": {
|
| 1395 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 1396 |
+
"items": {
|
| 1397 |
+
"type": "string"
|
| 1398 |
+
},
|
| 1399 |
+
"type": "array"
|
| 1400 |
+
}
|
| 1401 |
+
},
|
| 1402 |
+
"type": "object"
|
| 1403 |
+
}
|
| 1404 |
+
},
|
| 1405 |
+
"servicePath": "",
|
| 1406 |
+
"title": "Cloud Functions API",
|
| 1407 |
+
"version": "v1",
|
| 1408 |
+
"version_module": true
|
| 1409 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json
ADDED
|
@@ -0,0 +1,411 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/monitoring": {
|
| 9 |
+
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
|
| 10 |
+
},
|
| 11 |
+
"https://www.googleapis.com/auth/monitoring.write": {
|
| 12 |
+
"description": "Publish metric data to your Google Cloud projects"
|
| 13 |
+
}
|
| 14 |
+
}
|
| 15 |
+
}
|
| 16 |
+
},
|
| 17 |
+
"basePath": "",
|
| 18 |
+
"baseUrl": "https://cloudprofiler.googleapis.com/",
|
| 19 |
+
"batchPath": "batch",
|
| 20 |
+
"canonicalName": "Cloud Profiler",
|
| 21 |
+
"description": "Manages continuous profiling information.",
|
| 22 |
+
"discoveryVersion": "v1",
|
| 23 |
+
"documentationLink": "https://cloud.google.com/profiler/",
|
| 24 |
+
"fullyEncodeReservedExpansion": true,
|
| 25 |
+
"icons": {
|
| 26 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 27 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 28 |
+
},
|
| 29 |
+
"id": "cloudprofiler:v2",
|
| 30 |
+
"kind": "discovery#restDescription",
|
| 31 |
+
"mtlsRootUrl": "https://cloudprofiler.mtls.googleapis.com/",
|
| 32 |
+
"name": "cloudprofiler",
|
| 33 |
+
"ownerDomain": "google.com",
|
| 34 |
+
"ownerName": "Google",
|
| 35 |
+
"parameters": {
|
| 36 |
+
"$.xgafv": {
|
| 37 |
+
"description": "V1 error format.",
|
| 38 |
+
"enum": [
|
| 39 |
+
"1",
|
| 40 |
+
"2"
|
| 41 |
+
],
|
| 42 |
+
"enumDescriptions": [
|
| 43 |
+
"v1 error format",
|
| 44 |
+
"v2 error format"
|
| 45 |
+
],
|
| 46 |
+
"location": "query",
|
| 47 |
+
"type": "string"
|
| 48 |
+
},
|
| 49 |
+
"access_token": {
|
| 50 |
+
"description": "OAuth access token.",
|
| 51 |
+
"location": "query",
|
| 52 |
+
"type": "string"
|
| 53 |
+
},
|
| 54 |
+
"alt": {
|
| 55 |
+
"default": "json",
|
| 56 |
+
"description": "Data format for response.",
|
| 57 |
+
"enum": [
|
| 58 |
+
"json",
|
| 59 |
+
"media",
|
| 60 |
+
"proto"
|
| 61 |
+
],
|
| 62 |
+
"enumDescriptions": [
|
| 63 |
+
"Responses with Content-Type of application/json",
|
| 64 |
+
"Media download with context-dependent Content-Type",
|
| 65 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 66 |
+
],
|
| 67 |
+
"location": "query",
|
| 68 |
+
"type": "string"
|
| 69 |
+
},
|
| 70 |
+
"callback": {
|
| 71 |
+
"description": "JSONP",
|
| 72 |
+
"location": "query",
|
| 73 |
+
"type": "string"
|
| 74 |
+
},
|
| 75 |
+
"fields": {
|
| 76 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 77 |
+
"location": "query",
|
| 78 |
+
"type": "string"
|
| 79 |
+
},
|
| 80 |
+
"key": {
|
| 81 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 82 |
+
"location": "query",
|
| 83 |
+
"type": "string"
|
| 84 |
+
},
|
| 85 |
+
"oauth_token": {
|
| 86 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "string"
|
| 89 |
+
},
|
| 90 |
+
"prettyPrint": {
|
| 91 |
+
"default": "true",
|
| 92 |
+
"description": "Returns response with indentations and line breaks.",
|
| 93 |
+
"location": "query",
|
| 94 |
+
"type": "boolean"
|
| 95 |
+
},
|
| 96 |
+
"quotaUser": {
|
| 97 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 98 |
+
"location": "query",
|
| 99 |
+
"type": "string"
|
| 100 |
+
},
|
| 101 |
+
"uploadType": {
|
| 102 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 103 |
+
"location": "query",
|
| 104 |
+
"type": "string"
|
| 105 |
+
},
|
| 106 |
+
"upload_protocol": {
|
| 107 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 108 |
+
"location": "query",
|
| 109 |
+
"type": "string"
|
| 110 |
+
}
|
| 111 |
+
},
|
| 112 |
+
"protocol": "rest",
|
| 113 |
+
"resources": {
|
| 114 |
+
"projects": {
|
| 115 |
+
"resources": {
|
| 116 |
+
"profiles": {
|
| 117 |
+
"methods": {
|
| 118 |
+
"create": {
|
| 119 |
+
"description": "CreateProfile creates a new profile resource in the online mode. _Direct use of this API is discouraged, please use a [supported profiler agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent) instead for profile collection._ The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named \"google.rpc.retryinfo-bin\". ",
|
| 120 |
+
"flatPath": "v2/projects/{projectsId}/profiles",
|
| 121 |
+
"httpMethod": "POST",
|
| 122 |
+
"id": "cloudprofiler.projects.profiles.create",
|
| 123 |
+
"parameterOrder": [
|
| 124 |
+
"parent"
|
| 125 |
+
],
|
| 126 |
+
"parameters": {
|
| 127 |
+
"parent": {
|
| 128 |
+
"description": "Parent project to create the profile in.",
|
| 129 |
+
"location": "path",
|
| 130 |
+
"pattern": "^projects/[^/]+$",
|
| 131 |
+
"required": true,
|
| 132 |
+
"type": "string"
|
| 133 |
+
}
|
| 134 |
+
},
|
| 135 |
+
"path": "v2/{+parent}/profiles",
|
| 136 |
+
"request": {
|
| 137 |
+
"$ref": "CreateProfileRequest"
|
| 138 |
+
},
|
| 139 |
+
"response": {
|
| 140 |
+
"$ref": "Profile"
|
| 141 |
+
},
|
| 142 |
+
"scopes": [
|
| 143 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 144 |
+
"https://www.googleapis.com/auth/monitoring",
|
| 145 |
+
"https://www.googleapis.com/auth/monitoring.write"
|
| 146 |
+
]
|
| 147 |
+
},
|
| 148 |
+
"createOffline": {
|
| 149 |
+
"description": "CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it. _Direct use of this API is discouraged, please use a [supported profiler agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent) instead for profile collection._",
|
| 150 |
+
"flatPath": "v2/projects/{projectsId}/profiles:createOffline",
|
| 151 |
+
"httpMethod": "POST",
|
| 152 |
+
"id": "cloudprofiler.projects.profiles.createOffline",
|
| 153 |
+
"parameterOrder": [
|
| 154 |
+
"parent"
|
| 155 |
+
],
|
| 156 |
+
"parameters": {
|
| 157 |
+
"parent": {
|
| 158 |
+
"description": "Parent project to create the profile in.",
|
| 159 |
+
"location": "path",
|
| 160 |
+
"pattern": "^projects/[^/]+$",
|
| 161 |
+
"required": true,
|
| 162 |
+
"type": "string"
|
| 163 |
+
}
|
| 164 |
+
},
|
| 165 |
+
"path": "v2/{+parent}/profiles:createOffline",
|
| 166 |
+
"request": {
|
| 167 |
+
"$ref": "Profile"
|
| 168 |
+
},
|
| 169 |
+
"response": {
|
| 170 |
+
"$ref": "Profile"
|
| 171 |
+
},
|
| 172 |
+
"scopes": [
|
| 173 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 174 |
+
"https://www.googleapis.com/auth/monitoring",
|
| 175 |
+
"https://www.googleapis.com/auth/monitoring.write"
|
| 176 |
+
]
|
| 177 |
+
},
|
| 178 |
+
"list": {
|
| 179 |
+
"description": "Lists profiles which have been collected so far and for which the caller has permission to view.",
|
| 180 |
+
"flatPath": "v2/projects/{projectsId}/profiles",
|
| 181 |
+
"httpMethod": "GET",
|
| 182 |
+
"id": "cloudprofiler.projects.profiles.list",
|
| 183 |
+
"parameterOrder": [
|
| 184 |
+
"parent"
|
| 185 |
+
],
|
| 186 |
+
"parameters": {
|
| 187 |
+
"pageSize": {
|
| 188 |
+
"description": "Optional. The maximum number of items to return. Default page_size is 1000. Max limit is 1000.",
|
| 189 |
+
"format": "int32",
|
| 190 |
+
"location": "query",
|
| 191 |
+
"type": "integer"
|
| 192 |
+
},
|
| 193 |
+
"pageToken": {
|
| 194 |
+
"description": "Optional. The token to continue pagination and get profiles from a particular page. When paginating, all other parameters provided to `ListProfiles` must match the call that provided the page token.",
|
| 195 |
+
"location": "query",
|
| 196 |
+
"type": "string"
|
| 197 |
+
},
|
| 198 |
+
"parent": {
|
| 199 |
+
"description": "Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}",
|
| 200 |
+
"location": "path",
|
| 201 |
+
"pattern": "^projects/[^/]+$",
|
| 202 |
+
"required": true,
|
| 203 |
+
"type": "string"
|
| 204 |
+
}
|
| 205 |
+
},
|
| 206 |
+
"path": "v2/{+parent}/profiles",
|
| 207 |
+
"response": {
|
| 208 |
+
"$ref": "ListProfilesResponse"
|
| 209 |
+
},
|
| 210 |
+
"scopes": [
|
| 211 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 212 |
+
"https://www.googleapis.com/auth/monitoring",
|
| 213 |
+
"https://www.googleapis.com/auth/monitoring.write"
|
| 214 |
+
]
|
| 215 |
+
},
|
| 216 |
+
"patch": {
|
| 217 |
+
"description": "UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation. _Direct use of this API is discouraged, please use a [supported profiler agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent) instead for profile collection._",
|
| 218 |
+
"flatPath": "v2/projects/{projectsId}/profiles/{profilesId}",
|
| 219 |
+
"httpMethod": "PATCH",
|
| 220 |
+
"id": "cloudprofiler.projects.profiles.patch",
|
| 221 |
+
"parameterOrder": [
|
| 222 |
+
"name"
|
| 223 |
+
],
|
| 224 |
+
"parameters": {
|
| 225 |
+
"name": {
|
| 226 |
+
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
|
| 227 |
+
"location": "path",
|
| 228 |
+
"pattern": "^projects/[^/]+/profiles/[^/]+$",
|
| 229 |
+
"required": true,
|
| 230 |
+
"type": "string"
|
| 231 |
+
},
|
| 232 |
+
"updateMask": {
|
| 233 |
+
"description": "Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.",
|
| 234 |
+
"format": "google-fieldmask",
|
| 235 |
+
"location": "query",
|
| 236 |
+
"type": "string"
|
| 237 |
+
}
|
| 238 |
+
},
|
| 239 |
+
"path": "v2/{+name}",
|
| 240 |
+
"request": {
|
| 241 |
+
"$ref": "Profile"
|
| 242 |
+
},
|
| 243 |
+
"response": {
|
| 244 |
+
"$ref": "Profile"
|
| 245 |
+
},
|
| 246 |
+
"scopes": [
|
| 247 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 248 |
+
"https://www.googleapis.com/auth/monitoring",
|
| 249 |
+
"https://www.googleapis.com/auth/monitoring.write"
|
| 250 |
+
]
|
| 251 |
+
}
|
| 252 |
+
}
|
| 253 |
+
}
|
| 254 |
+
}
|
| 255 |
+
}
|
| 256 |
+
},
|
| 257 |
+
"revision": "20240624",
|
| 258 |
+
"rootUrl": "https://cloudprofiler.googleapis.com/",
|
| 259 |
+
"schemas": {
|
| 260 |
+
"CreateProfileRequest": {
|
| 261 |
+
"description": "CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected. ",
|
| 262 |
+
"id": "CreateProfileRequest",
|
| 263 |
+
"properties": {
|
| 264 |
+
"deployment": {
|
| 265 |
+
"$ref": "Deployment",
|
| 266 |
+
"description": "Deployment details."
|
| 267 |
+
},
|
| 268 |
+
"profileType": {
|
| 269 |
+
"description": "One or more profile types that the agent is capable of providing.",
|
| 270 |
+
"items": {
|
| 271 |
+
"enum": [
|
| 272 |
+
"PROFILE_TYPE_UNSPECIFIED",
|
| 273 |
+
"CPU",
|
| 274 |
+
"WALL",
|
| 275 |
+
"HEAP",
|
| 276 |
+
"THREADS",
|
| 277 |
+
"CONTENTION",
|
| 278 |
+
"PEAK_HEAP",
|
| 279 |
+
"HEAP_ALLOC"
|
| 280 |
+
],
|
| 281 |
+
"enumDescriptions": [
|
| 282 |
+
"Unspecified profile type.",
|
| 283 |
+
"Thread CPU time sampling.",
|
| 284 |
+
"Wallclock time sampling. More expensive as stops all threads.",
|
| 285 |
+
"In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.",
|
| 286 |
+
"Single-shot collection of all thread stacks.",
|
| 287 |
+
"Synchronization contention profile.",
|
| 288 |
+
"Peak heap profile.",
|
| 289 |
+
"Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized."
|
| 290 |
+
],
|
| 291 |
+
"type": "string"
|
| 292 |
+
},
|
| 293 |
+
"type": "array"
|
| 294 |
+
}
|
| 295 |
+
},
|
| 296 |
+
"type": "object"
|
| 297 |
+
},
|
| 298 |
+
"Deployment": {
|
| 299 |
+
"description": "Deployment contains the deployment identification information.",
|
| 300 |
+
"id": "Deployment",
|
| 301 |
+
"properties": {
|
| 302 |
+
"labels": {
|
| 303 |
+
"additionalProperties": {
|
| 304 |
+
"type": "string"
|
| 305 |
+
},
|
| 306 |
+
"description": "Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named \"language\" can be used to record the programming language of the profiled deployment. The standard choices for the value include \"java\", \"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\". For deployments running on Google Cloud Platform, \"zone\" or \"region\" label should be present describing the deployment location. An example of a zone is \"us-central1-a\", an example of a region is \"us-central1\" or \"us-central\".",
|
| 307 |
+
"type": "object"
|
| 308 |
+
},
|
| 309 |
+
"projectId": {
|
| 310 |
+
"description": "Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.",
|
| 311 |
+
"type": "string"
|
| 312 |
+
},
|
| 313 |
+
"target": {
|
| 314 |
+
"description": "Target is the service name used to group related deployments: * Service name for App Engine Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct Compute Engine profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
|
| 315 |
+
"type": "string"
|
| 316 |
+
}
|
| 317 |
+
},
|
| 318 |
+
"type": "object"
|
| 319 |
+
},
|
| 320 |
+
"ListProfilesResponse": {
|
| 321 |
+
"description": "ListProfileResponse contains the list of collected profiles for deployments in projects which the user has permissions to view.",
|
| 322 |
+
"id": "ListProfilesResponse",
|
| 323 |
+
"properties": {
|
| 324 |
+
"nextPageToken": {
|
| 325 |
+
"description": "Token to receive the next page of results. This field maybe empty if there are no more profiles to fetch.",
|
| 326 |
+
"type": "string"
|
| 327 |
+
},
|
| 328 |
+
"profiles": {
|
| 329 |
+
"description": "List of profiles fetched.",
|
| 330 |
+
"items": {
|
| 331 |
+
"$ref": "Profile"
|
| 332 |
+
},
|
| 333 |
+
"type": "array"
|
| 334 |
+
},
|
| 335 |
+
"skippedProfiles": {
|
| 336 |
+
"description": "Number of profiles that were skipped in the current page since they were not able to be fetched successfully. This should typically be zero. A non-zero value may indicate a transient failure, in which case if the number is too high for your use case, the call may be retried.",
|
| 337 |
+
"format": "int32",
|
| 338 |
+
"type": "integer"
|
| 339 |
+
}
|
| 340 |
+
},
|
| 341 |
+
"type": "object"
|
| 342 |
+
},
|
| 343 |
+
"Profile": {
|
| 344 |
+
"description": "Profile resource.",
|
| 345 |
+
"id": "Profile",
|
| 346 |
+
"properties": {
|
| 347 |
+
"deployment": {
|
| 348 |
+
"$ref": "Deployment",
|
| 349 |
+
"description": "Deployment this profile corresponds to."
|
| 350 |
+
},
|
| 351 |
+
"duration": {
|
| 352 |
+
"description": "Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).",
|
| 353 |
+
"format": "google-duration",
|
| 354 |
+
"type": "string"
|
| 355 |
+
},
|
| 356 |
+
"labels": {
|
| 357 |
+
"additionalProperties": {
|
| 358 |
+
"type": "string"
|
| 359 |
+
},
|
| 360 |
+
"description": "Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.",
|
| 361 |
+
"type": "object"
|
| 362 |
+
},
|
| 363 |
+
"name": {
|
| 364 |
+
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
|
| 365 |
+
"readOnly": true,
|
| 366 |
+
"type": "string"
|
| 367 |
+
},
|
| 368 |
+
"profileBytes": {
|
| 369 |
+
"description": "Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.",
|
| 370 |
+
"format": "byte",
|
| 371 |
+
"type": "string"
|
| 372 |
+
},
|
| 373 |
+
"profileType": {
|
| 374 |
+
"description": "Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.",
|
| 375 |
+
"enum": [
|
| 376 |
+
"PROFILE_TYPE_UNSPECIFIED",
|
| 377 |
+
"CPU",
|
| 378 |
+
"WALL",
|
| 379 |
+
"HEAP",
|
| 380 |
+
"THREADS",
|
| 381 |
+
"CONTENTION",
|
| 382 |
+
"PEAK_HEAP",
|
| 383 |
+
"HEAP_ALLOC"
|
| 384 |
+
],
|
| 385 |
+
"enumDescriptions": [
|
| 386 |
+
"Unspecified profile type.",
|
| 387 |
+
"Thread CPU time sampling.",
|
| 388 |
+
"Wallclock time sampling. More expensive as stops all threads.",
|
| 389 |
+
"In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.",
|
| 390 |
+
"Single-shot collection of all thread stacks.",
|
| 391 |
+
"Synchronization contention profile.",
|
| 392 |
+
"Peak heap profile.",
|
| 393 |
+
"Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized."
|
| 394 |
+
],
|
| 395 |
+
"type": "string"
|
| 396 |
+
},
|
| 397 |
+
"startTime": {
|
| 398 |
+
"description": "Output only. Start time for the profile. This output is only present in response from the ListProfiles method.",
|
| 399 |
+
"format": "google-datetime",
|
| 400 |
+
"readOnly": true,
|
| 401 |
+
"type": "string"
|
| 402 |
+
}
|
| 403 |
+
},
|
| 404 |
+
"type": "object"
|
| 405 |
+
}
|
| 406 |
+
},
|
| 407 |
+
"servicePath": "",
|
| 408 |
+
"title": "Cloud Profiler API",
|
| 409 |
+
"version": "v2",
|
| 410 |
+
"version_module": true
|
| 411 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json
ADDED
|
@@ -0,0 +1,1144 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only": {
|
| 9 |
+
"description": "View your data across Google Cloud services and see the email address of your Google Account"
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "Cloud Resource Manager",
|
| 18 |
+
"description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://cloud.google.com/resource-manager",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "cloudresourcemanager:v2beta1",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
|
| 29 |
+
"name": "cloudresourcemanager",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"parameters": {
|
| 33 |
+
"$.xgafv": {
|
| 34 |
+
"description": "V1 error format.",
|
| 35 |
+
"enum": [
|
| 36 |
+
"1",
|
| 37 |
+
"2"
|
| 38 |
+
],
|
| 39 |
+
"enumDescriptions": [
|
| 40 |
+
"v1 error format",
|
| 41 |
+
"v2 error format"
|
| 42 |
+
],
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"access_token": {
|
| 47 |
+
"description": "OAuth access token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"alt": {
|
| 52 |
+
"default": "json",
|
| 53 |
+
"description": "Data format for response.",
|
| 54 |
+
"enum": [
|
| 55 |
+
"json",
|
| 56 |
+
"media",
|
| 57 |
+
"proto"
|
| 58 |
+
],
|
| 59 |
+
"enumDescriptions": [
|
| 60 |
+
"Responses with Content-Type of application/json",
|
| 61 |
+
"Media download with context-dependent Content-Type",
|
| 62 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 63 |
+
],
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"callback": {
|
| 68 |
+
"description": "JSONP",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
},
|
| 72 |
+
"fields": {
|
| 73 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 74 |
+
"location": "query",
|
| 75 |
+
"type": "string"
|
| 76 |
+
},
|
| 77 |
+
"key": {
|
| 78 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 79 |
+
"location": "query",
|
| 80 |
+
"type": "string"
|
| 81 |
+
},
|
| 82 |
+
"oauth_token": {
|
| 83 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 84 |
+
"location": "query",
|
| 85 |
+
"type": "string"
|
| 86 |
+
},
|
| 87 |
+
"prettyPrint": {
|
| 88 |
+
"default": "true",
|
| 89 |
+
"description": "Returns response with indentations and line breaks.",
|
| 90 |
+
"location": "query",
|
| 91 |
+
"type": "boolean"
|
| 92 |
+
},
|
| 93 |
+
"quotaUser": {
|
| 94 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 95 |
+
"location": "query",
|
| 96 |
+
"type": "string"
|
| 97 |
+
},
|
| 98 |
+
"uploadType": {
|
| 99 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 100 |
+
"location": "query",
|
| 101 |
+
"type": "string"
|
| 102 |
+
},
|
| 103 |
+
"upload_protocol": {
|
| 104 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 105 |
+
"location": "query",
|
| 106 |
+
"type": "string"
|
| 107 |
+
}
|
| 108 |
+
},
|
| 109 |
+
"protocol": "rest",
|
| 110 |
+
"resources": {
|
| 111 |
+
"folders": {
|
| 112 |
+
"methods": {
|
| 113 |
+
"create": {
|
| 114 |
+
"description": "Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folders that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 10. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.",
|
| 115 |
+
"flatPath": "v2/folders",
|
| 116 |
+
"httpMethod": "POST",
|
| 117 |
+
"id": "cloudresourcemanager.folders.create",
|
| 118 |
+
"parameterOrder": [],
|
| 119 |
+
"parameters": {
|
| 120 |
+
"parent": {
|
| 121 |
+
"description": "Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
| 122 |
+
"location": "query",
|
| 123 |
+
"type": "string"
|
| 124 |
+
}
|
| 125 |
+
},
|
| 126 |
+
"path": "v2/folders",
|
| 127 |
+
"request": {
|
| 128 |
+
"$ref": "Folder"
|
| 129 |
+
},
|
| 130 |
+
"response": {
|
| 131 |
+
"$ref": "Operation"
|
| 132 |
+
},
|
| 133 |
+
"scopes": [
|
| 134 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 135 |
+
]
|
| 136 |
+
},
|
| 137 |
+
"delete": {
|
| 138 |
+
"description": "Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder.",
|
| 139 |
+
"flatPath": "v2/folders/{foldersId}",
|
| 140 |
+
"httpMethod": "DELETE",
|
| 141 |
+
"id": "cloudresourcemanager.folders.delete",
|
| 142 |
+
"parameterOrder": [
|
| 143 |
+
"name"
|
| 144 |
+
],
|
| 145 |
+
"parameters": {
|
| 146 |
+
"name": {
|
| 147 |
+
"description": "Required. the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`.",
|
| 148 |
+
"location": "path",
|
| 149 |
+
"pattern": "^folders/[^/]+$",
|
| 150 |
+
"required": true,
|
| 151 |
+
"type": "string"
|
| 152 |
+
}
|
| 153 |
+
},
|
| 154 |
+
"path": "v2/{+name}",
|
| 155 |
+
"response": {
|
| 156 |
+
"$ref": "Folder"
|
| 157 |
+
},
|
| 158 |
+
"scopes": [
|
| 159 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 160 |
+
]
|
| 161 |
+
},
|
| 162 |
+
"get": {
|
| 163 |
+
"description": "Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder.",
|
| 164 |
+
"flatPath": "v2/folders/{foldersId}",
|
| 165 |
+
"httpMethod": "GET",
|
| 166 |
+
"id": "cloudresourcemanager.folders.get",
|
| 167 |
+
"parameterOrder": [
|
| 168 |
+
"name"
|
| 169 |
+
],
|
| 170 |
+
"parameters": {
|
| 171 |
+
"name": {
|
| 172 |
+
"description": "Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`.",
|
| 173 |
+
"location": "path",
|
| 174 |
+
"pattern": "^folders/[^/]+$",
|
| 175 |
+
"required": true,
|
| 176 |
+
"type": "string"
|
| 177 |
+
}
|
| 178 |
+
},
|
| 179 |
+
"path": "v2/{+name}",
|
| 180 |
+
"response": {
|
| 181 |
+
"$ref": "Folder"
|
| 182 |
+
},
|
| 183 |
+
"scopes": [
|
| 184 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 185 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 186 |
+
]
|
| 187 |
+
},
|
| 188 |
+
"getIamPolicy": {
|
| 189 |
+
"description": "Gets the access control policy for a Folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the Folder's resource name, e.g. \"folders/1234\". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.",
|
| 190 |
+
"flatPath": "v2/folders/{foldersId}:getIamPolicy",
|
| 191 |
+
"httpMethod": "POST",
|
| 192 |
+
"id": "cloudresourcemanager.folders.getIamPolicy",
|
| 193 |
+
"parameterOrder": [
|
| 194 |
+
"resource"
|
| 195 |
+
],
|
| 196 |
+
"parameters": {
|
| 197 |
+
"resource": {
|
| 198 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 199 |
+
"location": "path",
|
| 200 |
+
"pattern": "^folders/[^/]+$",
|
| 201 |
+
"required": true,
|
| 202 |
+
"type": "string"
|
| 203 |
+
}
|
| 204 |
+
},
|
| 205 |
+
"path": "v2/{+resource}:getIamPolicy",
|
| 206 |
+
"request": {
|
| 207 |
+
"$ref": "GetIamPolicyRequest"
|
| 208 |
+
},
|
| 209 |
+
"response": {
|
| 210 |
+
"$ref": "Policy"
|
| 211 |
+
},
|
| 212 |
+
"scopes": [
|
| 213 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 214 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 215 |
+
]
|
| 216 |
+
},
|
| 217 |
+
"list": {
|
| 218 |
+
"description": "Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.",
|
| 219 |
+
"flatPath": "v2/folders",
|
| 220 |
+
"httpMethod": "GET",
|
| 221 |
+
"id": "cloudresourcemanager.folders.list",
|
| 222 |
+
"parameterOrder": [],
|
| 223 |
+
"parameters": {
|
| 224 |
+
"pageSize": {
|
| 225 |
+
"description": "Optional. The maximum number of Folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
|
| 226 |
+
"format": "int32",
|
| 227 |
+
"location": "query",
|
| 228 |
+
"type": "integer"
|
| 229 |
+
},
|
| 230 |
+
"pageToken": {
|
| 231 |
+
"description": "Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.",
|
| 232 |
+
"location": "query",
|
| 233 |
+
"type": "string"
|
| 234 |
+
},
|
| 235 |
+
"parent": {
|
| 236 |
+
"description": "Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.",
|
| 237 |
+
"location": "query",
|
| 238 |
+
"type": "string"
|
| 239 |
+
},
|
| 240 |
+
"showDeleted": {
|
| 241 |
+
"description": "Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false.",
|
| 242 |
+
"location": "query",
|
| 243 |
+
"type": "boolean"
|
| 244 |
+
}
|
| 245 |
+
},
|
| 246 |
+
"path": "v2/folders",
|
| 247 |
+
"response": {
|
| 248 |
+
"$ref": "ListFoldersResponse"
|
| 249 |
+
},
|
| 250 |
+
"scopes": [
|
| 251 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 252 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 253 |
+
]
|
| 254 |
+
},
|
| 255 |
+
"move": {
|
| 256 |
+
"description": "Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.",
|
| 257 |
+
"flatPath": "v2/folders/{foldersId}:move",
|
| 258 |
+
"httpMethod": "POST",
|
| 259 |
+
"id": "cloudresourcemanager.folders.move",
|
| 260 |
+
"parameterOrder": [
|
| 261 |
+
"name"
|
| 262 |
+
],
|
| 263 |
+
"parameters": {
|
| 264 |
+
"name": {
|
| 265 |
+
"description": "Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}",
|
| 266 |
+
"location": "path",
|
| 267 |
+
"pattern": "^folders/[^/]+$",
|
| 268 |
+
"required": true,
|
| 269 |
+
"type": "string"
|
| 270 |
+
}
|
| 271 |
+
},
|
| 272 |
+
"path": "v2/{+name}:move",
|
| 273 |
+
"request": {
|
| 274 |
+
"$ref": "MoveFolderRequest"
|
| 275 |
+
},
|
| 276 |
+
"response": {
|
| 277 |
+
"$ref": "Operation"
|
| 278 |
+
},
|
| 279 |
+
"scopes": [
|
| 280 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 281 |
+
]
|
| 282 |
+
},
|
| 283 |
+
"patch": {
|
| 284 |
+
"description": "Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\\p{L}\\p{N}{1,28}[\\p{L}\\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.",
|
| 285 |
+
"flatPath": "v2/folders/{foldersId}",
|
| 286 |
+
"httpMethod": "PATCH",
|
| 287 |
+
"id": "cloudresourcemanager.folders.patch",
|
| 288 |
+
"parameterOrder": [
|
| 289 |
+
"name"
|
| 290 |
+
],
|
| 291 |
+
"parameters": {
|
| 292 |
+
"name": {
|
| 293 |
+
"description": "Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".",
|
| 294 |
+
"location": "path",
|
| 295 |
+
"pattern": "^folders/[^/]+$",
|
| 296 |
+
"required": true,
|
| 297 |
+
"type": "string"
|
| 298 |
+
},
|
| 299 |
+
"updateMask": {
|
| 300 |
+
"description": "Required. Fields to be updated. Only the `display_name` can be updated.",
|
| 301 |
+
"format": "google-fieldmask",
|
| 302 |
+
"location": "query",
|
| 303 |
+
"type": "string"
|
| 304 |
+
}
|
| 305 |
+
},
|
| 306 |
+
"path": "v2/{+name}",
|
| 307 |
+
"request": {
|
| 308 |
+
"$ref": "Folder"
|
| 309 |
+
},
|
| 310 |
+
"response": {
|
| 311 |
+
"$ref": "Folder"
|
| 312 |
+
},
|
| 313 |
+
"scopes": [
|
| 314 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 315 |
+
]
|
| 316 |
+
},
|
| 317 |
+
"search": {
|
| 318 |
+
"description": "Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.",
|
| 319 |
+
"flatPath": "v2/folders:search",
|
| 320 |
+
"httpMethod": "POST",
|
| 321 |
+
"id": "cloudresourcemanager.folders.search",
|
| 322 |
+
"parameterOrder": [],
|
| 323 |
+
"parameters": {},
|
| 324 |
+
"path": "v2/folders:search",
|
| 325 |
+
"request": {
|
| 326 |
+
"$ref": "SearchFoldersRequest"
|
| 327 |
+
},
|
| 328 |
+
"response": {
|
| 329 |
+
"$ref": "SearchFoldersResponse"
|
| 330 |
+
},
|
| 331 |
+
"scopes": [
|
| 332 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 333 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 334 |
+
]
|
| 335 |
+
},
|
| 336 |
+
"setIamPolicy": {
|
| 337 |
+
"description": "Sets the access control policy on a Folder, replacing any existing policy. The `resource` field should be the Folder's resource name, e.g. \"folders/1234\". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder.",
|
| 338 |
+
"flatPath": "v2/folders/{foldersId}:setIamPolicy",
|
| 339 |
+
"httpMethod": "POST",
|
| 340 |
+
"id": "cloudresourcemanager.folders.setIamPolicy",
|
| 341 |
+
"parameterOrder": [
|
| 342 |
+
"resource"
|
| 343 |
+
],
|
| 344 |
+
"parameters": {
|
| 345 |
+
"resource": {
|
| 346 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 347 |
+
"location": "path",
|
| 348 |
+
"pattern": "^folders/[^/]+$",
|
| 349 |
+
"required": true,
|
| 350 |
+
"type": "string"
|
| 351 |
+
}
|
| 352 |
+
},
|
| 353 |
+
"path": "v2/{+resource}:setIamPolicy",
|
| 354 |
+
"request": {
|
| 355 |
+
"$ref": "SetIamPolicyRequest"
|
| 356 |
+
},
|
| 357 |
+
"response": {
|
| 358 |
+
"$ref": "Policy"
|
| 359 |
+
},
|
| 360 |
+
"scopes": [
|
| 361 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 362 |
+
]
|
| 363 |
+
},
|
| 364 |
+
"testIamPermissions": {
|
| 365 |
+
"description": "Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. \"folders/1234\". There are no permissions required for making this API call.",
|
| 366 |
+
"flatPath": "v2/folders/{foldersId}:testIamPermissions",
|
| 367 |
+
"httpMethod": "POST",
|
| 368 |
+
"id": "cloudresourcemanager.folders.testIamPermissions",
|
| 369 |
+
"parameterOrder": [
|
| 370 |
+
"resource"
|
| 371 |
+
],
|
| 372 |
+
"parameters": {
|
| 373 |
+
"resource": {
|
| 374 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 375 |
+
"location": "path",
|
| 376 |
+
"pattern": "^folders/[^/]+$",
|
| 377 |
+
"required": true,
|
| 378 |
+
"type": "string"
|
| 379 |
+
}
|
| 380 |
+
},
|
| 381 |
+
"path": "v2/{+resource}:testIamPermissions",
|
| 382 |
+
"request": {
|
| 383 |
+
"$ref": "TestIamPermissionsRequest"
|
| 384 |
+
},
|
| 385 |
+
"response": {
|
| 386 |
+
"$ref": "TestIamPermissionsResponse"
|
| 387 |
+
},
|
| 388 |
+
"scopes": [
|
| 389 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 390 |
+
]
|
| 391 |
+
},
|
| 392 |
+
"undelete": {
|
| 393 |
+
"description": "Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.",
|
| 394 |
+
"flatPath": "v2/folders/{foldersId}:undelete",
|
| 395 |
+
"httpMethod": "POST",
|
| 396 |
+
"id": "cloudresourcemanager.folders.undelete",
|
| 397 |
+
"parameterOrder": [
|
| 398 |
+
"name"
|
| 399 |
+
],
|
| 400 |
+
"parameters": {
|
| 401 |
+
"name": {
|
| 402 |
+
"description": "Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`.",
|
| 403 |
+
"location": "path",
|
| 404 |
+
"pattern": "^folders/[^/]+$",
|
| 405 |
+
"required": true,
|
| 406 |
+
"type": "string"
|
| 407 |
+
}
|
| 408 |
+
},
|
| 409 |
+
"path": "v2/{+name}:undelete",
|
| 410 |
+
"request": {
|
| 411 |
+
"$ref": "UndeleteFolderRequest"
|
| 412 |
+
},
|
| 413 |
+
"response": {
|
| 414 |
+
"$ref": "Folder"
|
| 415 |
+
},
|
| 416 |
+
"scopes": [
|
| 417 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 418 |
+
]
|
| 419 |
+
}
|
| 420 |
+
}
|
| 421 |
+
},
|
| 422 |
+
"operations": {
|
| 423 |
+
"methods": {
|
| 424 |
+
"get": {
|
| 425 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 426 |
+
"flatPath": "v1/operations/{operationsId}",
|
| 427 |
+
"httpMethod": "GET",
|
| 428 |
+
"id": "cloudresourcemanager.operations.get",
|
| 429 |
+
"parameterOrder": [
|
| 430 |
+
"name"
|
| 431 |
+
],
|
| 432 |
+
"parameters": {
|
| 433 |
+
"name": {
|
| 434 |
+
"description": "The name of the operation resource.",
|
| 435 |
+
"location": "path",
|
| 436 |
+
"pattern": "^operations/.*$",
|
| 437 |
+
"required": true,
|
| 438 |
+
"type": "string"
|
| 439 |
+
}
|
| 440 |
+
},
|
| 441 |
+
"path": "v1/{+name}",
|
| 442 |
+
"response": {
|
| 443 |
+
"$ref": "Operation"
|
| 444 |
+
},
|
| 445 |
+
"scopes": [
|
| 446 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 447 |
+
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
| 448 |
+
]
|
| 449 |
+
}
|
| 450 |
+
}
|
| 451 |
+
}
|
| 452 |
+
},
|
| 453 |
+
"revision": "20240707",
|
| 454 |
+
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
|
| 455 |
+
"schemas": {
|
| 456 |
+
"AuditConfig": {
|
| 457 |
+
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
|
| 458 |
+
"id": "AuditConfig",
|
| 459 |
+
"properties": {
|
| 460 |
+
"auditLogConfigs": {
|
| 461 |
+
"description": "The configuration for logging of each type of permission.",
|
| 462 |
+
"items": {
|
| 463 |
+
"$ref": "AuditLogConfig"
|
| 464 |
+
},
|
| 465 |
+
"type": "array"
|
| 466 |
+
},
|
| 467 |
+
"service": {
|
| 468 |
+
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
|
| 469 |
+
"type": "string"
|
| 470 |
+
}
|
| 471 |
+
},
|
| 472 |
+
"type": "object"
|
| 473 |
+
},
|
| 474 |
+
"AuditLogConfig": {
|
| 475 |
+
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
|
| 476 |
+
"id": "AuditLogConfig",
|
| 477 |
+
"properties": {
|
| 478 |
+
"exemptedMembers": {
|
| 479 |
+
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
|
| 480 |
+
"items": {
|
| 481 |
+
"type": "string"
|
| 482 |
+
},
|
| 483 |
+
"type": "array"
|
| 484 |
+
},
|
| 485 |
+
"logType": {
|
| 486 |
+
"description": "The log type that this config enables.",
|
| 487 |
+
"enum": [
|
| 488 |
+
"LOG_TYPE_UNSPECIFIED",
|
| 489 |
+
"ADMIN_READ",
|
| 490 |
+
"DATA_WRITE",
|
| 491 |
+
"DATA_READ"
|
| 492 |
+
],
|
| 493 |
+
"enumDescriptions": [
|
| 494 |
+
"Default case. Should never be this.",
|
| 495 |
+
"Admin reads. Example: CloudIAM getIamPolicy",
|
| 496 |
+
"Data writes. Example: CloudSQL Users create",
|
| 497 |
+
"Data reads. Example: CloudSQL Users list"
|
| 498 |
+
],
|
| 499 |
+
"type": "string"
|
| 500 |
+
}
|
| 501 |
+
},
|
| 502 |
+
"type": "object"
|
| 503 |
+
},
|
| 504 |
+
"Binding": {
|
| 505 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 506 |
+
"id": "Binding",
|
| 507 |
+
"properties": {
|
| 508 |
+
"condition": {
|
| 509 |
+
"$ref": "Expr",
|
| 510 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 511 |
+
},
|
| 512 |
+
"members": {
|
| 513 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 514 |
+
"items": {
|
| 515 |
+
"type": "string"
|
| 516 |
+
},
|
| 517 |
+
"type": "array"
|
| 518 |
+
},
|
| 519 |
+
"role": {
|
| 520 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 521 |
+
"type": "string"
|
| 522 |
+
}
|
| 523 |
+
},
|
| 524 |
+
"type": "object"
|
| 525 |
+
},
|
| 526 |
+
"CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation": {
|
| 527 |
+
"description": "Metadata describing a long running folder operation",
|
| 528 |
+
"id": "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation",
|
| 529 |
+
"properties": {
|
| 530 |
+
"destinationParent": {
|
| 531 |
+
"description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.",
|
| 532 |
+
"type": "string"
|
| 533 |
+
},
|
| 534 |
+
"displayName": {
|
| 535 |
+
"description": "The display name of the folder.",
|
| 536 |
+
"type": "string"
|
| 537 |
+
},
|
| 538 |
+
"operationType": {
|
| 539 |
+
"description": "The type of this operation.",
|
| 540 |
+
"enum": [
|
| 541 |
+
"OPERATION_TYPE_UNSPECIFIED",
|
| 542 |
+
"CREATE",
|
| 543 |
+
"MOVE"
|
| 544 |
+
],
|
| 545 |
+
"enumDescriptions": [
|
| 546 |
+
"Operation type not specified.",
|
| 547 |
+
"A create folder operation.",
|
| 548 |
+
"A move folder operation."
|
| 549 |
+
],
|
| 550 |
+
"type": "string"
|
| 551 |
+
},
|
| 552 |
+
"sourceParent": {
|
| 553 |
+
"description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.",
|
| 554 |
+
"type": "string"
|
| 555 |
+
}
|
| 556 |
+
},
|
| 557 |
+
"type": "object"
|
| 558 |
+
},
|
| 559 |
+
"CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation": {
|
| 560 |
+
"description": "Metadata describing a long running folder operation",
|
| 561 |
+
"id": "CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation",
|
| 562 |
+
"properties": {
|
| 563 |
+
"destinationParent": {
|
| 564 |
+
"description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.",
|
| 565 |
+
"type": "string"
|
| 566 |
+
},
|
| 567 |
+
"displayName": {
|
| 568 |
+
"description": "The display name of the folder.",
|
| 569 |
+
"type": "string"
|
| 570 |
+
},
|
| 571 |
+
"operationType": {
|
| 572 |
+
"description": "The type of this operation.",
|
| 573 |
+
"enum": [
|
| 574 |
+
"OPERATION_TYPE_UNSPECIFIED",
|
| 575 |
+
"CREATE",
|
| 576 |
+
"MOVE"
|
| 577 |
+
],
|
| 578 |
+
"enumDescriptions": [
|
| 579 |
+
"Operation type not specified.",
|
| 580 |
+
"A create folder operation.",
|
| 581 |
+
"A move folder operation."
|
| 582 |
+
],
|
| 583 |
+
"type": "string"
|
| 584 |
+
},
|
| 585 |
+
"sourceParent": {
|
| 586 |
+
"description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.",
|
| 587 |
+
"type": "string"
|
| 588 |
+
}
|
| 589 |
+
},
|
| 590 |
+
"type": "object"
|
| 591 |
+
},
|
| 592 |
+
"CreateFolderMetadata": {
|
| 593 |
+
"description": "Metadata pertaining to the Folder creation process.",
|
| 594 |
+
"id": "CreateFolderMetadata",
|
| 595 |
+
"properties": {
|
| 596 |
+
"displayName": {
|
| 597 |
+
"description": "The display name of the folder.",
|
| 598 |
+
"type": "string"
|
| 599 |
+
},
|
| 600 |
+
"parent": {
|
| 601 |
+
"description": "The resource name of the folder or organization we are creating the folder under.",
|
| 602 |
+
"type": "string"
|
| 603 |
+
}
|
| 604 |
+
},
|
| 605 |
+
"type": "object"
|
| 606 |
+
},
|
| 607 |
+
"CreateProjectMetadata": {
|
| 608 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.",
|
| 609 |
+
"id": "CreateProjectMetadata",
|
| 610 |
+
"properties": {
|
| 611 |
+
"createTime": {
|
| 612 |
+
"description": "Creation time of the project creation workflow.",
|
| 613 |
+
"format": "google-datetime",
|
| 614 |
+
"type": "string"
|
| 615 |
+
},
|
| 616 |
+
"gettable": {
|
| 617 |
+
"description": "True if the project can be retrieved using `GetProject`. No other operations on the project are guaranteed to work until the project creation is complete.",
|
| 618 |
+
"type": "boolean"
|
| 619 |
+
},
|
| 620 |
+
"ready": {
|
| 621 |
+
"description": "True if the project creation process is complete.",
|
| 622 |
+
"type": "boolean"
|
| 623 |
+
}
|
| 624 |
+
},
|
| 625 |
+
"type": "object"
|
| 626 |
+
},
|
| 627 |
+
"CreateTagBindingMetadata": {
|
| 628 |
+
"description": "Runtime operation information for creating a TagValue.",
|
| 629 |
+
"id": "CreateTagBindingMetadata",
|
| 630 |
+
"properties": {},
|
| 631 |
+
"type": "object"
|
| 632 |
+
},
|
| 633 |
+
"CreateTagKeyMetadata": {
|
| 634 |
+
"description": "Runtime operation information for creating a TagKey.",
|
| 635 |
+
"id": "CreateTagKeyMetadata",
|
| 636 |
+
"properties": {},
|
| 637 |
+
"type": "object"
|
| 638 |
+
},
|
| 639 |
+
"CreateTagValueMetadata": {
|
| 640 |
+
"description": "Runtime operation information for creating a TagValue.",
|
| 641 |
+
"id": "CreateTagValueMetadata",
|
| 642 |
+
"properties": {},
|
| 643 |
+
"type": "object"
|
| 644 |
+
},
|
| 645 |
+
"DeleteFolderMetadata": {
|
| 646 |
+
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
|
| 647 |
+
"id": "DeleteFolderMetadata",
|
| 648 |
+
"properties": {},
|
| 649 |
+
"type": "object"
|
| 650 |
+
},
|
| 651 |
+
"DeleteOrganizationMetadata": {
|
| 652 |
+
"description": "A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.",
|
| 653 |
+
"id": "DeleteOrganizationMetadata",
|
| 654 |
+
"properties": {},
|
| 655 |
+
"type": "object"
|
| 656 |
+
},
|
| 657 |
+
"DeleteProjectMetadata": {
|
| 658 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.",
|
| 659 |
+
"id": "DeleteProjectMetadata",
|
| 660 |
+
"properties": {},
|
| 661 |
+
"type": "object"
|
| 662 |
+
},
|
| 663 |
+
"DeleteTagBindingMetadata": {
|
| 664 |
+
"description": "Runtime operation information for deleting a TagBinding.",
|
| 665 |
+
"id": "DeleteTagBindingMetadata",
|
| 666 |
+
"properties": {},
|
| 667 |
+
"type": "object"
|
| 668 |
+
},
|
| 669 |
+
"DeleteTagKeyMetadata": {
|
| 670 |
+
"description": "Runtime operation information for deleting a TagKey.",
|
| 671 |
+
"id": "DeleteTagKeyMetadata",
|
| 672 |
+
"properties": {},
|
| 673 |
+
"type": "object"
|
| 674 |
+
},
|
| 675 |
+
"DeleteTagValueMetadata": {
|
| 676 |
+
"description": "Runtime operation information for deleting a TagValue.",
|
| 677 |
+
"id": "DeleteTagValueMetadata",
|
| 678 |
+
"properties": {},
|
| 679 |
+
"type": "object"
|
| 680 |
+
},
|
| 681 |
+
"Expr": {
|
| 682 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 683 |
+
"id": "Expr",
|
| 684 |
+
"properties": {
|
| 685 |
+
"description": {
|
| 686 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 687 |
+
"type": "string"
|
| 688 |
+
},
|
| 689 |
+
"expression": {
|
| 690 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 691 |
+
"type": "string"
|
| 692 |
+
},
|
| 693 |
+
"location": {
|
| 694 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 695 |
+
"type": "string"
|
| 696 |
+
},
|
| 697 |
+
"title": {
|
| 698 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 699 |
+
"type": "string"
|
| 700 |
+
}
|
| 701 |
+
},
|
| 702 |
+
"type": "object"
|
| 703 |
+
},
|
| 704 |
+
"Folder": {
|
| 705 |
+
"description": "A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.",
|
| 706 |
+
"id": "Folder",
|
| 707 |
+
"properties": {
|
| 708 |
+
"createTime": {
|
| 709 |
+
"description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
|
| 710 |
+
"format": "google-datetime",
|
| 711 |
+
"readOnly": true,
|
| 712 |
+
"type": "string"
|
| 713 |
+
},
|
| 714 |
+
"displayName": {
|
| 715 |
+
"description": "The folder's display name. A folder's display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?`.",
|
| 716 |
+
"type": "string"
|
| 717 |
+
},
|
| 718 |
+
"lifecycleState": {
|
| 719 |
+
"description": "Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.",
|
| 720 |
+
"enum": [
|
| 721 |
+
"LIFECYCLE_STATE_UNSPECIFIED",
|
| 722 |
+
"ACTIVE",
|
| 723 |
+
"DELETE_REQUESTED"
|
| 724 |
+
],
|
| 725 |
+
"enumDescriptions": [
|
| 726 |
+
"Unspecified state.",
|
| 727 |
+
"The normal and active state.",
|
| 728 |
+
"The folder has been marked for deletion by the user."
|
| 729 |
+
],
|
| 730 |
+
"readOnly": true,
|
| 731 |
+
"type": "string"
|
| 732 |
+
},
|
| 733 |
+
"name": {
|
| 734 |
+
"description": "Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".",
|
| 735 |
+
"readOnly": true,
|
| 736 |
+
"type": "string"
|
| 737 |
+
},
|
| 738 |
+
"parent": {
|
| 739 |
+
"description": "Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.",
|
| 740 |
+
"type": "string"
|
| 741 |
+
},
|
| 742 |
+
"tags": {
|
| 743 |
+
"additionalProperties": {
|
| 744 |
+
"type": "string"
|
| 745 |
+
},
|
| 746 |
+
"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.",
|
| 747 |
+
"type": "object"
|
| 748 |
+
}
|
| 749 |
+
},
|
| 750 |
+
"type": "object"
|
| 751 |
+
},
|
| 752 |
+
"FolderOperation": {
|
| 753 |
+
"description": "Metadata describing a long running folder operation",
|
| 754 |
+
"id": "FolderOperation",
|
| 755 |
+
"properties": {
|
| 756 |
+
"destinationParent": {
|
| 757 |
+
"description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.",
|
| 758 |
+
"type": "string"
|
| 759 |
+
},
|
| 760 |
+
"displayName": {
|
| 761 |
+
"description": "The display name of the folder.",
|
| 762 |
+
"type": "string"
|
| 763 |
+
},
|
| 764 |
+
"operationType": {
|
| 765 |
+
"description": "The type of this operation.",
|
| 766 |
+
"enum": [
|
| 767 |
+
"OPERATION_TYPE_UNSPECIFIED",
|
| 768 |
+
"CREATE",
|
| 769 |
+
"MOVE"
|
| 770 |
+
],
|
| 771 |
+
"enumDescriptions": [
|
| 772 |
+
"Operation type not specified.",
|
| 773 |
+
"A create folder operation.",
|
| 774 |
+
"A move folder operation."
|
| 775 |
+
],
|
| 776 |
+
"type": "string"
|
| 777 |
+
},
|
| 778 |
+
"sourceParent": {
|
| 779 |
+
"description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.",
|
| 780 |
+
"type": "string"
|
| 781 |
+
}
|
| 782 |
+
},
|
| 783 |
+
"type": "object"
|
| 784 |
+
},
|
| 785 |
+
"FolderOperationError": {
|
| 786 |
+
"description": "A classification of the Folder Operation error.",
|
| 787 |
+
"id": "FolderOperationError",
|
| 788 |
+
"properties": {
|
| 789 |
+
"errorMessageId": {
|
| 790 |
+
"description": "The type of operation error experienced.",
|
| 791 |
+
"enum": [
|
| 792 |
+
"ERROR_TYPE_UNSPECIFIED",
|
| 793 |
+
"ACTIVE_FOLDER_HEIGHT_VIOLATION",
|
| 794 |
+
"MAX_CHILD_FOLDERS_VIOLATION",
|
| 795 |
+
"FOLDER_NAME_UNIQUENESS_VIOLATION",
|
| 796 |
+
"RESOURCE_DELETED_VIOLATION",
|
| 797 |
+
"PARENT_DELETED_VIOLATION",
|
| 798 |
+
"CYCLE_INTRODUCED_VIOLATION",
|
| 799 |
+
"FOLDER_BEING_MOVED_VIOLATION",
|
| 800 |
+
"FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
|
| 801 |
+
"DELETED_FOLDER_HEIGHT_VIOLATION"
|
| 802 |
+
],
|
| 803 |
+
"enumDescriptions": [
|
| 804 |
+
"The error type was unrecognized or unspecified.",
|
| 805 |
+
"The attempted action would violate the max folder depth constraint.",
|
| 806 |
+
"The attempted action would violate the max child folders constraint.",
|
| 807 |
+
"The attempted action would violate the locally-unique folder display_name constraint.",
|
| 808 |
+
"The resource being moved has been deleted.",
|
| 809 |
+
"The resource a folder was being added to has been deleted.",
|
| 810 |
+
"The attempted action would introduce cycle in resource path.",
|
| 811 |
+
"The attempted action would move a folder that is already being moved.",
|
| 812 |
+
"The folder the caller is trying to delete contains active resources.",
|
| 813 |
+
"The attempted action would violate the max deleted folder depth constraint."
|
| 814 |
+
],
|
| 815 |
+
"type": "string"
|
| 816 |
+
}
|
| 817 |
+
},
|
| 818 |
+
"type": "object"
|
| 819 |
+
},
|
| 820 |
+
"GetIamPolicyRequest": {
|
| 821 |
+
"description": "Request message for `GetIamPolicy` method.",
|
| 822 |
+
"id": "GetIamPolicyRequest",
|
| 823 |
+
"properties": {
|
| 824 |
+
"options": {
|
| 825 |
+
"$ref": "GetPolicyOptions",
|
| 826 |
+
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."
|
| 827 |
+
}
|
| 828 |
+
},
|
| 829 |
+
"type": "object"
|
| 830 |
+
},
|
| 831 |
+
"GetPolicyOptions": {
|
| 832 |
+
"description": "Encapsulates settings provided to GetIamPolicy.",
|
| 833 |
+
"id": "GetPolicyOptions",
|
| 834 |
+
"properties": {
|
| 835 |
+
"requestedPolicyVersion": {
|
| 836 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 837 |
+
"format": "int32",
|
| 838 |
+
"type": "integer"
|
| 839 |
+
}
|
| 840 |
+
},
|
| 841 |
+
"type": "object"
|
| 842 |
+
},
|
| 843 |
+
"ListFoldersResponse": {
|
| 844 |
+
"description": "The ListFolders response message.",
|
| 845 |
+
"id": "ListFoldersResponse",
|
| 846 |
+
"properties": {
|
| 847 |
+
"folders": {
|
| 848 |
+
"description": "A possibly paginated list of Folders that are direct descendants of the specified parent resource.",
|
| 849 |
+
"items": {
|
| 850 |
+
"$ref": "Folder"
|
| 851 |
+
},
|
| 852 |
+
"type": "array"
|
| 853 |
+
},
|
| 854 |
+
"nextPageToken": {
|
| 855 |
+
"description": "A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue.",
|
| 856 |
+
"type": "string"
|
| 857 |
+
}
|
| 858 |
+
},
|
| 859 |
+
"type": "object"
|
| 860 |
+
},
|
| 861 |
+
"MoveFolderMetadata": {
|
| 862 |
+
"description": "Metadata pertaining to the folder move process.",
|
| 863 |
+
"id": "MoveFolderMetadata",
|
| 864 |
+
"properties": {
|
| 865 |
+
"destinationParent": {
|
| 866 |
+
"description": "The resource name of the folder or organization to move the folder to.",
|
| 867 |
+
"type": "string"
|
| 868 |
+
},
|
| 869 |
+
"displayName": {
|
| 870 |
+
"description": "The display name of the folder.",
|
| 871 |
+
"type": "string"
|
| 872 |
+
},
|
| 873 |
+
"sourceParent": {
|
| 874 |
+
"description": "The resource name of the folder's parent.",
|
| 875 |
+
"type": "string"
|
| 876 |
+
}
|
| 877 |
+
},
|
| 878 |
+
"type": "object"
|
| 879 |
+
},
|
| 880 |
+
"MoveFolderRequest": {
|
| 881 |
+
"description": "The MoveFolder request message.",
|
| 882 |
+
"id": "MoveFolderRequest",
|
| 883 |
+
"properties": {
|
| 884 |
+
"destinationParent": {
|
| 885 |
+
"description": "Required. The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
| 886 |
+
"type": "string"
|
| 887 |
+
}
|
| 888 |
+
},
|
| 889 |
+
"type": "object"
|
| 890 |
+
},
|
| 891 |
+
"MoveProjectMetadata": {
|
| 892 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by MoveProject.",
|
| 893 |
+
"id": "MoveProjectMetadata",
|
| 894 |
+
"properties": {},
|
| 895 |
+
"type": "object"
|
| 896 |
+
},
|
| 897 |
+
"Operation": {
|
| 898 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 899 |
+
"id": "Operation",
|
| 900 |
+
"properties": {
|
| 901 |
+
"done": {
|
| 902 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 903 |
+
"type": "boolean"
|
| 904 |
+
},
|
| 905 |
+
"error": {
|
| 906 |
+
"$ref": "Status",
|
| 907 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 908 |
+
},
|
| 909 |
+
"metadata": {
|
| 910 |
+
"additionalProperties": {
|
| 911 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 912 |
+
"type": "any"
|
| 913 |
+
},
|
| 914 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 915 |
+
"type": "object"
|
| 916 |
+
},
|
| 917 |
+
"name": {
|
| 918 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 919 |
+
"type": "string"
|
| 920 |
+
},
|
| 921 |
+
"response": {
|
| 922 |
+
"additionalProperties": {
|
| 923 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 924 |
+
"type": "any"
|
| 925 |
+
},
|
| 926 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 927 |
+
"type": "object"
|
| 928 |
+
}
|
| 929 |
+
},
|
| 930 |
+
"type": "object"
|
| 931 |
+
},
|
| 932 |
+
"Policy": {
|
| 933 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 934 |
+
"id": "Policy",
|
| 935 |
+
"properties": {
|
| 936 |
+
"auditConfigs": {
|
| 937 |
+
"description": "Specifies cloud audit logging configuration for this policy.",
|
| 938 |
+
"items": {
|
| 939 |
+
"$ref": "AuditConfig"
|
| 940 |
+
},
|
| 941 |
+
"type": "array"
|
| 942 |
+
},
|
| 943 |
+
"bindings": {
|
| 944 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 945 |
+
"items": {
|
| 946 |
+
"$ref": "Binding"
|
| 947 |
+
},
|
| 948 |
+
"type": "array"
|
| 949 |
+
},
|
| 950 |
+
"etag": {
|
| 951 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 952 |
+
"format": "byte",
|
| 953 |
+
"type": "string"
|
| 954 |
+
},
|
| 955 |
+
"version": {
|
| 956 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 957 |
+
"format": "int32",
|
| 958 |
+
"type": "integer"
|
| 959 |
+
}
|
| 960 |
+
},
|
| 961 |
+
"type": "object"
|
| 962 |
+
},
|
| 963 |
+
"ProjectCreationStatus": {
|
| 964 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.",
|
| 965 |
+
"id": "ProjectCreationStatus",
|
| 966 |
+
"properties": {
|
| 967 |
+
"createTime": {
|
| 968 |
+
"description": "Creation time of the project creation workflow.",
|
| 969 |
+
"format": "google-datetime",
|
| 970 |
+
"type": "string"
|
| 971 |
+
},
|
| 972 |
+
"gettable": {
|
| 973 |
+
"description": "True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.",
|
| 974 |
+
"type": "boolean"
|
| 975 |
+
},
|
| 976 |
+
"ready": {
|
| 977 |
+
"description": "True if the project creation process is complete.",
|
| 978 |
+
"type": "boolean"
|
| 979 |
+
}
|
| 980 |
+
},
|
| 981 |
+
"type": "object"
|
| 982 |
+
},
|
| 983 |
+
"SearchFoldersRequest": {
|
| 984 |
+
"description": "The request message for searching folders.",
|
| 985 |
+
"id": "SearchFoldersRequest",
|
| 986 |
+
"properties": {
|
| 987 |
+
"pageSize": {
|
| 988 |
+
"description": "Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
|
| 989 |
+
"format": "int32",
|
| 990 |
+
"type": "integer"
|
| 991 |
+
},
|
| 992 |
+
"pageToken": {
|
| 993 |
+
"description": "Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.",
|
| 994 |
+
"type": "string"
|
| 995 |
+
},
|
| 996 |
+
"query": {
|
| 997 |
+
"description": "Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".",
|
| 998 |
+
"type": "string"
|
| 999 |
+
}
|
| 1000 |
+
},
|
| 1001 |
+
"type": "object"
|
| 1002 |
+
},
|
| 1003 |
+
"SearchFoldersResponse": {
|
| 1004 |
+
"description": "The response message for searching folders.",
|
| 1005 |
+
"id": "SearchFoldersResponse",
|
| 1006 |
+
"properties": {
|
| 1007 |
+
"folders": {
|
| 1008 |
+
"description": "A possibly paginated folder search results. the specified parent resource.",
|
| 1009 |
+
"items": {
|
| 1010 |
+
"$ref": "Folder"
|
| 1011 |
+
},
|
| 1012 |
+
"type": "array"
|
| 1013 |
+
},
|
| 1014 |
+
"nextPageToken": {
|
| 1015 |
+
"description": "A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue.",
|
| 1016 |
+
"type": "string"
|
| 1017 |
+
}
|
| 1018 |
+
},
|
| 1019 |
+
"type": "object"
|
| 1020 |
+
},
|
| 1021 |
+
"SetIamPolicyRequest": {
|
| 1022 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 1023 |
+
"id": "SetIamPolicyRequest",
|
| 1024 |
+
"properties": {
|
| 1025 |
+
"policy": {
|
| 1026 |
+
"$ref": "Policy",
|
| 1027 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 1028 |
+
},
|
| 1029 |
+
"updateMask": {
|
| 1030 |
+
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
|
| 1031 |
+
"format": "google-fieldmask",
|
| 1032 |
+
"type": "string"
|
| 1033 |
+
}
|
| 1034 |
+
},
|
| 1035 |
+
"type": "object"
|
| 1036 |
+
},
|
| 1037 |
+
"Status": {
|
| 1038 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 1039 |
+
"id": "Status",
|
| 1040 |
+
"properties": {
|
| 1041 |
+
"code": {
|
| 1042 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 1043 |
+
"format": "int32",
|
| 1044 |
+
"type": "integer"
|
| 1045 |
+
},
|
| 1046 |
+
"details": {
|
| 1047 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 1048 |
+
"items": {
|
| 1049 |
+
"additionalProperties": {
|
| 1050 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1051 |
+
"type": "any"
|
| 1052 |
+
},
|
| 1053 |
+
"type": "object"
|
| 1054 |
+
},
|
| 1055 |
+
"type": "array"
|
| 1056 |
+
},
|
| 1057 |
+
"message": {
|
| 1058 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 1059 |
+
"type": "string"
|
| 1060 |
+
}
|
| 1061 |
+
},
|
| 1062 |
+
"type": "object"
|
| 1063 |
+
},
|
| 1064 |
+
"TestIamPermissionsRequest": {
|
| 1065 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 1066 |
+
"id": "TestIamPermissionsRequest",
|
| 1067 |
+
"properties": {
|
| 1068 |
+
"permissions": {
|
| 1069 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 1070 |
+
"items": {
|
| 1071 |
+
"type": "string"
|
| 1072 |
+
},
|
| 1073 |
+
"type": "array"
|
| 1074 |
+
}
|
| 1075 |
+
},
|
| 1076 |
+
"type": "object"
|
| 1077 |
+
},
|
| 1078 |
+
"TestIamPermissionsResponse": {
|
| 1079 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 1080 |
+
"id": "TestIamPermissionsResponse",
|
| 1081 |
+
"properties": {
|
| 1082 |
+
"permissions": {
|
| 1083 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 1084 |
+
"items": {
|
| 1085 |
+
"type": "string"
|
| 1086 |
+
},
|
| 1087 |
+
"type": "array"
|
| 1088 |
+
}
|
| 1089 |
+
},
|
| 1090 |
+
"type": "object"
|
| 1091 |
+
},
|
| 1092 |
+
"UndeleteFolderMetadata": {
|
| 1093 |
+
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.",
|
| 1094 |
+
"id": "UndeleteFolderMetadata",
|
| 1095 |
+
"properties": {},
|
| 1096 |
+
"type": "object"
|
| 1097 |
+
},
|
| 1098 |
+
"UndeleteFolderRequest": {
|
| 1099 |
+
"description": "The UndeleteFolder request message.",
|
| 1100 |
+
"id": "UndeleteFolderRequest",
|
| 1101 |
+
"properties": {},
|
| 1102 |
+
"type": "object"
|
| 1103 |
+
},
|
| 1104 |
+
"UndeleteOrganizationMetadata": {
|
| 1105 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.",
|
| 1106 |
+
"id": "UndeleteOrganizationMetadata",
|
| 1107 |
+
"properties": {},
|
| 1108 |
+
"type": "object"
|
| 1109 |
+
},
|
| 1110 |
+
"UndeleteProjectMetadata": {
|
| 1111 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.",
|
| 1112 |
+
"id": "UndeleteProjectMetadata",
|
| 1113 |
+
"properties": {},
|
| 1114 |
+
"type": "object"
|
| 1115 |
+
},
|
| 1116 |
+
"UpdateFolderMetadata": {
|
| 1117 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
|
| 1118 |
+
"id": "UpdateFolderMetadata",
|
| 1119 |
+
"properties": {},
|
| 1120 |
+
"type": "object"
|
| 1121 |
+
},
|
| 1122 |
+
"UpdateProjectMetadata": {
|
| 1123 |
+
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateProject.",
|
| 1124 |
+
"id": "UpdateProjectMetadata",
|
| 1125 |
+
"properties": {},
|
| 1126 |
+
"type": "object"
|
| 1127 |
+
},
|
| 1128 |
+
"UpdateTagKeyMetadata": {
|
| 1129 |
+
"description": "Runtime operation information for updating a TagKey.",
|
| 1130 |
+
"id": "UpdateTagKeyMetadata",
|
| 1131 |
+
"properties": {},
|
| 1132 |
+
"type": "object"
|
| 1133 |
+
},
|
| 1134 |
+
"UpdateTagValueMetadata": {
|
| 1135 |
+
"description": "Runtime operation information for updating a TagValue.",
|
| 1136 |
+
"id": "UpdateTagValueMetadata",
|
| 1137 |
+
"properties": {},
|
| 1138 |
+
"type": "object"
|
| 1139 |
+
}
|
| 1140 |
+
},
|
| 1141 |
+
"servicePath": "",
|
| 1142 |
+
"title": "Cloud Resource Manager API",
|
| 1143 |
+
"version": "v2beta1"
|
| 1144 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudsupport.v2.json
ADDED
|
@@ -0,0 +1,1398 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://cloudsupport.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Cloud Support",
|
| 15 |
+
"description": "Manages Google Cloud technical support cases for Customer Care support offerings. ",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/support/docs/apis",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "cloudsupport:v2",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://cloudsupport.mtls.googleapis.com/",
|
| 26 |
+
"name": "cloudsupport",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"caseClassifications": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"search": {
|
| 111 |
+
"description": "Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `\" > \"`. For example, `\"Technical Issue > Compute > Compute Engine\"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:\"*Compute%20Engine*\"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=\"v2\", discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version=v2\", ) request = supportApiService.caseClassifications().search( query='display_name:\"*Compute Engine*\"' ) print(request.execute()) ```",
|
| 112 |
+
"flatPath": "v2/caseClassifications:search",
|
| 113 |
+
"httpMethod": "GET",
|
| 114 |
+
"id": "cloudsupport.caseClassifications.search",
|
| 115 |
+
"parameterOrder": [],
|
| 116 |
+
"parameters": {
|
| 117 |
+
"pageSize": {
|
| 118 |
+
"description": "The maximum number of classifications fetched with each request.",
|
| 119 |
+
"format": "int32",
|
| 120 |
+
"location": "query",
|
| 121 |
+
"type": "integer"
|
| 122 |
+
},
|
| 123 |
+
"pageToken": {
|
| 124 |
+
"description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.",
|
| 125 |
+
"location": "query",
|
| 126 |
+
"type": "string"
|
| 127 |
+
},
|
| 128 |
+
"query": {
|
| 129 |
+
"description": "An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.",
|
| 130 |
+
"location": "query",
|
| 131 |
+
"type": "string"
|
| 132 |
+
}
|
| 133 |
+
},
|
| 134 |
+
"path": "v2/caseClassifications:search",
|
| 135 |
+
"response": {
|
| 136 |
+
"$ref": "SearchCaseClassificationsResponse"
|
| 137 |
+
},
|
| 138 |
+
"scopes": [
|
| 139 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 140 |
+
]
|
| 141 |
+
}
|
| 142 |
+
}
|
| 143 |
+
},
|
| 144 |
+
"cases": {
|
| 145 |
+
"methods": {
|
| 146 |
+
"close": {
|
| 147 |
+
"description": "Close a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case:close\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().close( name=\"projects/some-project/cases/43595344\" ) print(request.execute()) ```",
|
| 148 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:close",
|
| 149 |
+
"httpMethod": "POST",
|
| 150 |
+
"id": "cloudsupport.cases.close",
|
| 151 |
+
"parameterOrder": [
|
| 152 |
+
"name"
|
| 153 |
+
],
|
| 154 |
+
"parameters": {
|
| 155 |
+
"name": {
|
| 156 |
+
"description": "Required. The name of the case to close.",
|
| 157 |
+
"location": "path",
|
| 158 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 159 |
+
"required": true,
|
| 160 |
+
"type": "string"
|
| 161 |
+
}
|
| 162 |
+
},
|
| 163 |
+
"path": "v2/{+name}:close",
|
| 164 |
+
"request": {
|
| 165 |
+
"$ref": "CloseCaseRequest"
|
| 166 |
+
},
|
| 167 |
+
"response": {
|
| 168 |
+
"$ref": "Case"
|
| 169 |
+
},
|
| 170 |
+
"scopes": [
|
| 171 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 172 |
+
]
|
| 173 |
+
},
|
| 174 |
+
"create": {
|
| 175 |
+
"description": "Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"display_name\": \"Test case created by me.\", \"description\": \"a random test case, feel free to close\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, \"time_zone\": \"-07:00\", \"subscriber_email_addresses\": [ \"foo@domain.com\", \"bar@domain.com\" ], \"testCase\": true, \"priority\": \"P3\" }' \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().create( parent=\"projects/some-project\", body={ \"displayName\": \"A Test Case\", \"description\": \"This is a test case.\", \"testCase\": True, \"priority\": \"P2\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, }, ) print(request.execute()) ```",
|
| 176 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases",
|
| 177 |
+
"httpMethod": "POST",
|
| 178 |
+
"id": "cloudsupport.cases.create",
|
| 179 |
+
"parameterOrder": [
|
| 180 |
+
"parent"
|
| 181 |
+
],
|
| 182 |
+
"parameters": {
|
| 183 |
+
"parent": {
|
| 184 |
+
"description": "Required. The name of the parent under which the case should be created.",
|
| 185 |
+
"location": "path",
|
| 186 |
+
"pattern": "^[^/]+/[^/]+$",
|
| 187 |
+
"required": true,
|
| 188 |
+
"type": "string"
|
| 189 |
+
}
|
| 190 |
+
},
|
| 191 |
+
"path": "v2/{+parent}/cases",
|
| 192 |
+
"request": {
|
| 193 |
+
"$ref": "Case"
|
| 194 |
+
},
|
| 195 |
+
"response": {
|
| 196 |
+
"$ref": "Case"
|
| 197 |
+
},
|
| 198 |
+
"scopes": [
|
| 199 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 200 |
+
]
|
| 201 |
+
},
|
| 202 |
+
"escalate": {
|
| 203 |
+
"description": "Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\" } }' \\ \"https://cloudsupport.googleapis.com/v2/$case:escalate\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().escalate( name=\"projects/some-project/cases/43595344\", body={ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\", }, }, ) print(request.execute()) ```",
|
| 204 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:escalate",
|
| 205 |
+
"httpMethod": "POST",
|
| 206 |
+
"id": "cloudsupport.cases.escalate",
|
| 207 |
+
"parameterOrder": [
|
| 208 |
+
"name"
|
| 209 |
+
],
|
| 210 |
+
"parameters": {
|
| 211 |
+
"name": {
|
| 212 |
+
"description": "Required. The name of the case to be escalated.",
|
| 213 |
+
"location": "path",
|
| 214 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 215 |
+
"required": true,
|
| 216 |
+
"type": "string"
|
| 217 |
+
}
|
| 218 |
+
},
|
| 219 |
+
"path": "v2/{+name}:escalate",
|
| 220 |
+
"request": {
|
| 221 |
+
"$ref": "EscalateCaseRequest"
|
| 222 |
+
},
|
| 223 |
+
"response": {
|
| 224 |
+
"$ref": "Case"
|
| 225 |
+
},
|
| 226 |
+
"scopes": [
|
| 227 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 228 |
+
]
|
| 229 |
+
},
|
| 230 |
+
"get": {
|
| 231 |
+
"description": "Retrieve a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/16033687\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().get( name=\"projects/some-project/cases/43595344\", ) print(request.execute()) ```",
|
| 232 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}",
|
| 233 |
+
"httpMethod": "GET",
|
| 234 |
+
"id": "cloudsupport.cases.get",
|
| 235 |
+
"parameterOrder": [
|
| 236 |
+
"name"
|
| 237 |
+
],
|
| 238 |
+
"parameters": {
|
| 239 |
+
"name": {
|
| 240 |
+
"description": "Required. The full name of a case to be retrieved.",
|
| 241 |
+
"location": "path",
|
| 242 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 243 |
+
"required": true,
|
| 244 |
+
"type": "string"
|
| 245 |
+
}
|
| 246 |
+
},
|
| 247 |
+
"path": "v2/{+name}",
|
| 248 |
+
"response": {
|
| 249 |
+
"$ref": "Case"
|
| 250 |
+
},
|
| 251 |
+
"scopes": [
|
| 252 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 253 |
+
]
|
| 254 |
+
},
|
| 255 |
+
"list": {
|
| 256 |
+
"description": "Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().list(parent=\"projects/some-project\") print(request.execute()) ```",
|
| 257 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases",
|
| 258 |
+
"httpMethod": "GET",
|
| 259 |
+
"id": "cloudsupport.cases.list",
|
| 260 |
+
"parameterOrder": [
|
| 261 |
+
"parent"
|
| 262 |
+
],
|
| 263 |
+
"parameters": {
|
| 264 |
+
"filter": {
|
| 265 |
+
"description": "An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. EXAMPLES: - `state=CLOSED` - `state=OPEN AND creator.email=\"tester@example.com\"` - `state=OPEN AND (priority=P0 OR priority=P1)`",
|
| 266 |
+
"location": "query",
|
| 267 |
+
"type": "string"
|
| 268 |
+
},
|
| 269 |
+
"pageSize": {
|
| 270 |
+
"description": "The maximum number of cases fetched with each request. Defaults to 10.",
|
| 271 |
+
"format": "int32",
|
| 272 |
+
"location": "query",
|
| 273 |
+
"type": "integer"
|
| 274 |
+
},
|
| 275 |
+
"pageToken": {
|
| 276 |
+
"description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.",
|
| 277 |
+
"location": "query",
|
| 278 |
+
"type": "string"
|
| 279 |
+
},
|
| 280 |
+
"parent": {
|
| 281 |
+
"description": "Required. The name of a parent to list cases under.",
|
| 282 |
+
"location": "path",
|
| 283 |
+
"pattern": "^[^/]+/[^/]+$",
|
| 284 |
+
"required": true,
|
| 285 |
+
"type": "string"
|
| 286 |
+
}
|
| 287 |
+
},
|
| 288 |
+
"path": "v2/{+parent}/cases",
|
| 289 |
+
"response": {
|
| 290 |
+
"$ref": "ListCasesResponse"
|
| 291 |
+
},
|
| 292 |
+
"scopes": [
|
| 293 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 294 |
+
]
|
| 295 |
+
},
|
| 296 |
+
"patch": {
|
| 297 |
+
"description": "Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"priority\": \"P1\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case?updateMask=priority\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().patch( name=\"projects/some-project/cases/43112854\", body={ \"displayName\": \"This is Now a New Title\", \"priority\": \"P2\", }, ) print(request.execute()) ```",
|
| 298 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}",
|
| 299 |
+
"httpMethod": "PATCH",
|
| 300 |
+
"id": "cloudsupport.cases.patch",
|
| 301 |
+
"parameterOrder": [
|
| 302 |
+
"name"
|
| 303 |
+
],
|
| 304 |
+
"parameters": {
|
| 305 |
+
"name": {
|
| 306 |
+
"description": "The resource name for the case.",
|
| 307 |
+
"location": "path",
|
| 308 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 309 |
+
"required": true,
|
| 310 |
+
"type": "string"
|
| 311 |
+
},
|
| 312 |
+
"updateMask": {
|
| 313 |
+
"description": "A list of attributes of the case that should be updated. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.",
|
| 314 |
+
"format": "google-fieldmask",
|
| 315 |
+
"location": "query",
|
| 316 |
+
"type": "string"
|
| 317 |
+
}
|
| 318 |
+
},
|
| 319 |
+
"path": "v2/{+name}",
|
| 320 |
+
"request": {
|
| 321 |
+
"$ref": "Case"
|
| 322 |
+
},
|
| 323 |
+
"response": {
|
| 324 |
+
"$ref": "Case"
|
| 325 |
+
},
|
| 326 |
+
"scopes": [
|
| 327 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 328 |
+
]
|
| 329 |
+
},
|
| 330 |
+
"search": {
|
| 331 |
+
"description": "Search for cases using a query. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases:search\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().search( parent=\"projects/some-project\", query=\"state=OPEN\" ) print(request.execute()) ```",
|
| 332 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases:search",
|
| 333 |
+
"httpMethod": "GET",
|
| 334 |
+
"id": "cloudsupport.cases.search",
|
| 335 |
+
"parameterOrder": [
|
| 336 |
+
"parent"
|
| 337 |
+
],
|
| 338 |
+
"parameters": {
|
| 339 |
+
"pageSize": {
|
| 340 |
+
"description": "The maximum number of cases fetched with each request. The default page size is 10.",
|
| 341 |
+
"format": "int32",
|
| 342 |
+
"location": "query",
|
| 343 |
+
"type": "integer"
|
| 344 |
+
},
|
| 345 |
+
"pageToken": {
|
| 346 |
+
"description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.",
|
| 347 |
+
"location": "query",
|
| 348 |
+
"type": "string"
|
| 349 |
+
},
|
| 350 |
+
"parent": {
|
| 351 |
+
"description": "The name of the parent resource to search for cases under.",
|
| 352 |
+
"location": "path",
|
| 353 |
+
"pattern": "^[^/]+/[^/]+$",
|
| 354 |
+
"required": true,
|
| 355 |
+
"type": "string"
|
| 356 |
+
},
|
| 357 |
+
"query": {
|
| 358 |
+
"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`",
|
| 359 |
+
"location": "query",
|
| 360 |
+
"type": "string"
|
| 361 |
+
}
|
| 362 |
+
},
|
| 363 |
+
"path": "v2/{+parent}/cases:search",
|
| 364 |
+
"response": {
|
| 365 |
+
"$ref": "SearchCasesResponse"
|
| 366 |
+
},
|
| 367 |
+
"scopes": [
|
| 368 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 369 |
+
]
|
| 370 |
+
}
|
| 371 |
+
},
|
| 372 |
+
"resources": {
|
| 373 |
+
"attachments": {
|
| 374 |
+
"methods": {
|
| 375 |
+
"list": {
|
| 376 |
+
"description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
|
| 377 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments",
|
| 378 |
+
"httpMethod": "GET",
|
| 379 |
+
"id": "cloudsupport.cases.attachments.list",
|
| 380 |
+
"parameterOrder": [
|
| 381 |
+
"parent"
|
| 382 |
+
],
|
| 383 |
+
"parameters": {
|
| 384 |
+
"pageSize": {
|
| 385 |
+
"description": "The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100. The size of each page can be smaller than the requested page size and can include zero. For example, you could request 100 attachments on one page, receive 0, and then on the next page, receive 90.",
|
| 386 |
+
"format": "int32",
|
| 387 |
+
"location": "query",
|
| 388 |
+
"type": "integer"
|
| 389 |
+
},
|
| 390 |
+
"pageToken": {
|
| 391 |
+
"description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.",
|
| 392 |
+
"location": "query",
|
| 393 |
+
"type": "string"
|
| 394 |
+
},
|
| 395 |
+
"parent": {
|
| 396 |
+
"description": "Required. The name of the case for which attachments should be listed.",
|
| 397 |
+
"location": "path",
|
| 398 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 399 |
+
"required": true,
|
| 400 |
+
"type": "string"
|
| 401 |
+
}
|
| 402 |
+
},
|
| 403 |
+
"path": "v2/{+parent}/attachments",
|
| 404 |
+
"response": {
|
| 405 |
+
"$ref": "ListAttachmentsResponse"
|
| 406 |
+
},
|
| 407 |
+
"scopes": [
|
| 408 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 409 |
+
]
|
| 410 |
+
}
|
| 411 |
+
}
|
| 412 |
+
},
|
| 413 |
+
"comments": {
|
| 414 |
+
"methods": {
|
| 415 |
+
"create": {
|
| 416 |
+
"description": "Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43591344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"body\": \"This is a test comment.\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .create( parent=\"projects/some-project/cases/43595344\", body={\"body\": \"This is a test comment.\"}, ) ) print(request.execute()) ```",
|
| 417 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments",
|
| 418 |
+
"httpMethod": "POST",
|
| 419 |
+
"id": "cloudsupport.cases.comments.create",
|
| 420 |
+
"parameterOrder": [
|
| 421 |
+
"parent"
|
| 422 |
+
],
|
| 423 |
+
"parameters": {
|
| 424 |
+
"parent": {
|
| 425 |
+
"description": "Required. The name of the case to which the comment should be added.",
|
| 426 |
+
"location": "path",
|
| 427 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 428 |
+
"required": true,
|
| 429 |
+
"type": "string"
|
| 430 |
+
}
|
| 431 |
+
},
|
| 432 |
+
"path": "v2/{+parent}/comments",
|
| 433 |
+
"request": {
|
| 434 |
+
"$ref": "Comment"
|
| 435 |
+
},
|
| 436 |
+
"response": {
|
| 437 |
+
"$ref": "Comment"
|
| 438 |
+
},
|
| 439 |
+
"scopes": [
|
| 440 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 441 |
+
]
|
| 442 |
+
},
|
| 443 |
+
"list": {
|
| 444 |
+
"description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
|
| 445 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments",
|
| 446 |
+
"httpMethod": "GET",
|
| 447 |
+
"id": "cloudsupport.cases.comments.list",
|
| 448 |
+
"parameterOrder": [
|
| 449 |
+
"parent"
|
| 450 |
+
],
|
| 451 |
+
"parameters": {
|
| 452 |
+
"pageSize": {
|
| 453 |
+
"description": "The maximum number of comments to fetch. Defaults to 10.",
|
| 454 |
+
"format": "int32",
|
| 455 |
+
"location": "query",
|
| 456 |
+
"type": "integer"
|
| 457 |
+
},
|
| 458 |
+
"pageToken": {
|
| 459 |
+
"description": "A token identifying the page of results to return. If unspecified, the first page is returned.",
|
| 460 |
+
"location": "query",
|
| 461 |
+
"type": "string"
|
| 462 |
+
},
|
| 463 |
+
"parent": {
|
| 464 |
+
"description": "Required. The name of the case for which to list comments.",
|
| 465 |
+
"location": "path",
|
| 466 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 467 |
+
"required": true,
|
| 468 |
+
"type": "string"
|
| 469 |
+
}
|
| 470 |
+
},
|
| 471 |
+
"path": "v2/{+parent}/comments",
|
| 472 |
+
"response": {
|
| 473 |
+
"$ref": "ListCommentsResponse"
|
| 474 |
+
},
|
| 475 |
+
"scopes": [
|
| 476 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 477 |
+
]
|
| 478 |
+
}
|
| 479 |
+
}
|
| 480 |
+
}
|
| 481 |
+
}
|
| 482 |
+
},
|
| 483 |
+
"media": {
|
| 484 |
+
"methods": {
|
| 485 |
+
"download": {
|
| 486 |
+
"description": "Download a file attached to a case. Note: HTTP requests must append \"?alt=media\" to the URL. EXAMPLES: cURL: ```shell name=\"projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$name:download?alt=media\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.media().download( name=\"projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR\" ) request.uri = request.uri.split(\"?\")[0] + \"?alt=media\" print(request.execute()) ```",
|
| 487 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments/{attachmentsId}:download",
|
| 488 |
+
"httpMethod": "GET",
|
| 489 |
+
"id": "cloudsupport.media.download",
|
| 490 |
+
"parameterOrder": [
|
| 491 |
+
"name"
|
| 492 |
+
],
|
| 493 |
+
"parameters": {
|
| 494 |
+
"name": {
|
| 495 |
+
"description": "The name of the file attachment to download.",
|
| 496 |
+
"location": "path",
|
| 497 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$",
|
| 498 |
+
"required": true,
|
| 499 |
+
"type": "string"
|
| 500 |
+
}
|
| 501 |
+
},
|
| 502 |
+
"path": "v2/{+name}:download",
|
| 503 |
+
"response": {
|
| 504 |
+
"$ref": "Media"
|
| 505 |
+
},
|
| 506 |
+
"scopes": [
|
| 507 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 508 |
+
],
|
| 509 |
+
"supportsMediaDownload": true,
|
| 510 |
+
"useMediaDownloadService": true
|
| 511 |
+
},
|
| 512 |
+
"upload": {
|
| 513 |
+
"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```",
|
| 514 |
+
"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments",
|
| 515 |
+
"httpMethod": "POST",
|
| 516 |
+
"id": "cloudsupport.media.upload",
|
| 517 |
+
"mediaUpload": {
|
| 518 |
+
"accept": [
|
| 519 |
+
"*/*"
|
| 520 |
+
],
|
| 521 |
+
"protocols": {
|
| 522 |
+
"simple": {
|
| 523 |
+
"multipart": true,
|
| 524 |
+
"path": "/upload/v2/{+parent}/attachments"
|
| 525 |
+
}
|
| 526 |
+
}
|
| 527 |
+
},
|
| 528 |
+
"parameterOrder": [
|
| 529 |
+
"parent"
|
| 530 |
+
],
|
| 531 |
+
"parameters": {
|
| 532 |
+
"parent": {
|
| 533 |
+
"description": "Required. The name of the case or Cloud resource to which the attachment should be attached.",
|
| 534 |
+
"location": "path",
|
| 535 |
+
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
|
| 536 |
+
"required": true,
|
| 537 |
+
"type": "string"
|
| 538 |
+
}
|
| 539 |
+
},
|
| 540 |
+
"path": "v2/{+parent}/attachments",
|
| 541 |
+
"request": {
|
| 542 |
+
"$ref": "CreateAttachmentRequest"
|
| 543 |
+
},
|
| 544 |
+
"response": {
|
| 545 |
+
"$ref": "Attachment"
|
| 546 |
+
},
|
| 547 |
+
"scopes": [
|
| 548 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 549 |
+
],
|
| 550 |
+
"supportsMediaUpload": true
|
| 551 |
+
}
|
| 552 |
+
}
|
| 553 |
+
}
|
| 554 |
+
},
|
| 555 |
+
"revision": "20241231",
|
| 556 |
+
"rootUrl": "https://cloudsupport.googleapis.com/",
|
| 557 |
+
"schemas": {
|
| 558 |
+
"Actor": {
|
| 559 |
+
"description": "An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case.",
|
| 560 |
+
"id": "Actor",
|
| 561 |
+
"properties": {
|
| 562 |
+
"displayName": {
|
| 563 |
+
"description": "The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.",
|
| 564 |
+
"type": "string"
|
| 565 |
+
},
|
| 566 |
+
"email": {
|
| 567 |
+
"deprecated": true,
|
| 568 |
+
"description": "The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.",
|
| 569 |
+
"type": "string"
|
| 570 |
+
},
|
| 571 |
+
"googleSupport": {
|
| 572 |
+
"description": "Output only. Whether the actor is a Google support actor.",
|
| 573 |
+
"readOnly": true,
|
| 574 |
+
"type": "boolean"
|
| 575 |
+
},
|
| 576 |
+
"username": {
|
| 577 |
+
"description": "Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.",
|
| 578 |
+
"readOnly": true,
|
| 579 |
+
"type": "string"
|
| 580 |
+
}
|
| 581 |
+
},
|
| 582 |
+
"type": "object"
|
| 583 |
+
},
|
| 584 |
+
"Attachment": {
|
| 585 |
+
"description": "An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a \"case\" level, not a \"comment\" level.",
|
| 586 |
+
"id": "Attachment",
|
| 587 |
+
"properties": {
|
| 588 |
+
"createTime": {
|
| 589 |
+
"description": "Output only. The time at which the attachment was created.",
|
| 590 |
+
"format": "google-datetime",
|
| 591 |
+
"readOnly": true,
|
| 592 |
+
"type": "string"
|
| 593 |
+
},
|
| 594 |
+
"creator": {
|
| 595 |
+
"$ref": "Actor",
|
| 596 |
+
"description": "Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.",
|
| 597 |
+
"readOnly": true
|
| 598 |
+
},
|
| 599 |
+
"filename": {
|
| 600 |
+
"description": "The filename of the attachment (e.g. `\"graph.jpg\"`).",
|
| 601 |
+
"type": "string"
|
| 602 |
+
},
|
| 603 |
+
"mimeType": {
|
| 604 |
+
"description": "Output only. The MIME type of the attachment (e.g. text/plain).",
|
| 605 |
+
"readOnly": true,
|
| 606 |
+
"type": "string"
|
| 607 |
+
},
|
| 608 |
+
"name": {
|
| 609 |
+
"description": "Output only. The resource name of the attachment.",
|
| 610 |
+
"readOnly": true,
|
| 611 |
+
"type": "string"
|
| 612 |
+
},
|
| 613 |
+
"sizeBytes": {
|
| 614 |
+
"description": "Output only. The size of the attachment in bytes.",
|
| 615 |
+
"format": "int64",
|
| 616 |
+
"readOnly": true,
|
| 617 |
+
"type": "string"
|
| 618 |
+
}
|
| 619 |
+
},
|
| 620 |
+
"type": "object"
|
| 621 |
+
},
|
| 622 |
+
"Blobstore2Info": {
|
| 623 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 624 |
+
"id": "Blobstore2Info",
|
| 625 |
+
"properties": {
|
| 626 |
+
"blobGeneration": {
|
| 627 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 628 |
+
"format": "int64",
|
| 629 |
+
"type": "string"
|
| 630 |
+
},
|
| 631 |
+
"blobId": {
|
| 632 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 633 |
+
"type": "string"
|
| 634 |
+
},
|
| 635 |
+
"downloadReadHandle": {
|
| 636 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 637 |
+
"format": "byte",
|
| 638 |
+
"type": "string"
|
| 639 |
+
},
|
| 640 |
+
"readToken": {
|
| 641 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 642 |
+
"type": "string"
|
| 643 |
+
},
|
| 644 |
+
"uploadMetadataContainer": {
|
| 645 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 646 |
+
"format": "byte",
|
| 647 |
+
"type": "string"
|
| 648 |
+
}
|
| 649 |
+
},
|
| 650 |
+
"type": "object"
|
| 651 |
+
},
|
| 652 |
+
"Case": {
|
| 653 |
+
"description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).",
|
| 654 |
+
"id": "Case",
|
| 655 |
+
"properties": {
|
| 656 |
+
"classification": {
|
| 657 |
+
"$ref": "CaseClassification",
|
| 658 |
+
"description": "The issue classification applicable to this case."
|
| 659 |
+
},
|
| 660 |
+
"contactEmail": {
|
| 661 |
+
"description": "A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.",
|
| 662 |
+
"type": "string"
|
| 663 |
+
},
|
| 664 |
+
"createTime": {
|
| 665 |
+
"description": "Output only. The time this case was created.",
|
| 666 |
+
"format": "google-datetime",
|
| 667 |
+
"readOnly": true,
|
| 668 |
+
"type": "string"
|
| 669 |
+
},
|
| 670 |
+
"creator": {
|
| 671 |
+
"$ref": "Actor",
|
| 672 |
+
"description": "The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support."
|
| 673 |
+
},
|
| 674 |
+
"description": {
|
| 675 |
+
"description": "A broad description of the issue.",
|
| 676 |
+
"type": "string"
|
| 677 |
+
},
|
| 678 |
+
"displayName": {
|
| 679 |
+
"description": "The short summary of the issue reported in this case.",
|
| 680 |
+
"type": "string"
|
| 681 |
+
},
|
| 682 |
+
"escalated": {
|
| 683 |
+
"description": "Whether the case is currently escalated.",
|
| 684 |
+
"type": "boolean"
|
| 685 |
+
},
|
| 686 |
+
"languageCode": {
|
| 687 |
+
"description": "The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `\"en\"`, `\"zh-CN\"`, `\"zh-TW\"`, `\"ja\"`, `\"ko\"`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours",
|
| 688 |
+
"type": "string"
|
| 689 |
+
},
|
| 690 |
+
"name": {
|
| 691 |
+
"description": "The resource name for the case.",
|
| 692 |
+
"type": "string"
|
| 693 |
+
},
|
| 694 |
+
"priority": {
|
| 695 |
+
"description": "The priority of this case.",
|
| 696 |
+
"enum": [
|
| 697 |
+
"PRIORITY_UNSPECIFIED",
|
| 698 |
+
"P0",
|
| 699 |
+
"P1",
|
| 700 |
+
"P2",
|
| 701 |
+
"P3",
|
| 702 |
+
"P4"
|
| 703 |
+
],
|
| 704 |
+
"enumDescriptions": [
|
| 705 |
+
"Priority is undefined or has not been set yet.",
|
| 706 |
+
"Extreme impact on a production service. Service is hard down.",
|
| 707 |
+
"Critical impact on a production service. Service is currently unusable.",
|
| 708 |
+
"Severe impact on a production service. Service is usable but greatly impaired.",
|
| 709 |
+
"Medium impact on a production service. Service is available, but moderately impaired.",
|
| 710 |
+
"General questions or minor issues. Production service is fully available."
|
| 711 |
+
],
|
| 712 |
+
"type": "string"
|
| 713 |
+
},
|
| 714 |
+
"state": {
|
| 715 |
+
"description": "Output only. The current status of the support case.",
|
| 716 |
+
"enum": [
|
| 717 |
+
"STATE_UNSPECIFIED",
|
| 718 |
+
"NEW",
|
| 719 |
+
"IN_PROGRESS_GOOGLE_SUPPORT",
|
| 720 |
+
"ACTION_REQUIRED",
|
| 721 |
+
"SOLUTION_PROVIDED",
|
| 722 |
+
"CLOSED"
|
| 723 |
+
],
|
| 724 |
+
"enumDescriptions": [
|
| 725 |
+
"Case is in an unknown state.",
|
| 726 |
+
"The case has been created but no one is assigned to work on it yet.",
|
| 727 |
+
"The case is currently being handled by Google support.",
|
| 728 |
+
"Google is waiting for a response.",
|
| 729 |
+
"A solution has been offered for the case, but it isn't yet closed.",
|
| 730 |
+
"The case has been resolved."
|
| 731 |
+
],
|
| 732 |
+
"readOnly": true,
|
| 733 |
+
"type": "string"
|
| 734 |
+
},
|
| 735 |
+
"subscriberEmailAddresses": {
|
| 736 |
+
"description": "The email addresses to receive updates on this case.",
|
| 737 |
+
"items": {
|
| 738 |
+
"type": "string"
|
| 739 |
+
},
|
| 740 |
+
"type": "array"
|
| 741 |
+
},
|
| 742 |
+
"testCase": {
|
| 743 |
+
"description": "Whether this case was created for internal API testing and should not be acted on by the support team.",
|
| 744 |
+
"type": "boolean"
|
| 745 |
+
},
|
| 746 |
+
"timeZone": {
|
| 747 |
+
"description": "The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.",
|
| 748 |
+
"type": "string"
|
| 749 |
+
},
|
| 750 |
+
"updateTime": {
|
| 751 |
+
"description": "Output only. The time this case was last updated.",
|
| 752 |
+
"format": "google-datetime",
|
| 753 |
+
"readOnly": true,
|
| 754 |
+
"type": "string"
|
| 755 |
+
}
|
| 756 |
+
},
|
| 757 |
+
"type": "object"
|
| 758 |
+
},
|
| 759 |
+
"CaseClassification": {
|
| 760 |
+
"description": "A Case Classification represents the topic that a case is about. It's very important to use accurate classifications, because they're used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case.",
|
| 761 |
+
"id": "CaseClassification",
|
| 762 |
+
"properties": {
|
| 763 |
+
"displayName": {
|
| 764 |
+
"description": "A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.",
|
| 765 |
+
"type": "string"
|
| 766 |
+
},
|
| 767 |
+
"id": {
|
| 768 |
+
"description": "The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.",
|
| 769 |
+
"type": "string"
|
| 770 |
+
}
|
| 771 |
+
},
|
| 772 |
+
"type": "object"
|
| 773 |
+
},
|
| 774 |
+
"CloseCaseRequest": {
|
| 775 |
+
"description": "The request message for the CloseCase endpoint.",
|
| 776 |
+
"id": "CloseCaseRequest",
|
| 777 |
+
"properties": {},
|
| 778 |
+
"type": "object"
|
| 779 |
+
},
|
| 780 |
+
"Comment": {
|
| 781 |
+
"description": "A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.",
|
| 782 |
+
"id": "Comment",
|
| 783 |
+
"properties": {
|
| 784 |
+
"body": {
|
| 785 |
+
"description": "The full comment body. Maximum of 12800 characters.",
|
| 786 |
+
"type": "string"
|
| 787 |
+
},
|
| 788 |
+
"createTime": {
|
| 789 |
+
"description": "Output only. The time when the comment was created.",
|
| 790 |
+
"format": "google-datetime",
|
| 791 |
+
"readOnly": true,
|
| 792 |
+
"type": "string"
|
| 793 |
+
},
|
| 794 |
+
"creator": {
|
| 795 |
+
"$ref": "Actor",
|
| 796 |
+
"description": "Output only. The user or Google Support agent who created the comment.",
|
| 797 |
+
"readOnly": true
|
| 798 |
+
},
|
| 799 |
+
"name": {
|
| 800 |
+
"description": "Output only. Identifier. The resource name of the comment.",
|
| 801 |
+
"readOnly": true,
|
| 802 |
+
"type": "string"
|
| 803 |
+
},
|
| 804 |
+
"plainTextBody": {
|
| 805 |
+
"deprecated": true,
|
| 806 |
+
"description": "Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.",
|
| 807 |
+
"readOnly": true,
|
| 808 |
+
"type": "string"
|
| 809 |
+
}
|
| 810 |
+
},
|
| 811 |
+
"type": "object"
|
| 812 |
+
},
|
| 813 |
+
"CompositeMedia": {
|
| 814 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 815 |
+
"id": "CompositeMedia",
|
| 816 |
+
"properties": {
|
| 817 |
+
"blobRef": {
|
| 818 |
+
"deprecated": true,
|
| 819 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 820 |
+
"format": "byte",
|
| 821 |
+
"type": "string"
|
| 822 |
+
},
|
| 823 |
+
"blobstore2Info": {
|
| 824 |
+
"$ref": "Blobstore2Info",
|
| 825 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 826 |
+
},
|
| 827 |
+
"cosmoBinaryReference": {
|
| 828 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 829 |
+
"format": "byte",
|
| 830 |
+
"type": "string"
|
| 831 |
+
},
|
| 832 |
+
"crc32cHash": {
|
| 833 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 834 |
+
"format": "uint32",
|
| 835 |
+
"type": "integer"
|
| 836 |
+
},
|
| 837 |
+
"inline": {
|
| 838 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 839 |
+
"format": "byte",
|
| 840 |
+
"type": "string"
|
| 841 |
+
},
|
| 842 |
+
"length": {
|
| 843 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 844 |
+
"format": "int64",
|
| 845 |
+
"type": "string"
|
| 846 |
+
},
|
| 847 |
+
"md5Hash": {
|
| 848 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 849 |
+
"format": "byte",
|
| 850 |
+
"type": "string"
|
| 851 |
+
},
|
| 852 |
+
"objectId": {
|
| 853 |
+
"$ref": "ObjectId",
|
| 854 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 855 |
+
},
|
| 856 |
+
"path": {
|
| 857 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 858 |
+
"type": "string"
|
| 859 |
+
},
|
| 860 |
+
"referenceType": {
|
| 861 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 862 |
+
"enum": [
|
| 863 |
+
"PATH",
|
| 864 |
+
"BLOB_REF",
|
| 865 |
+
"INLINE",
|
| 866 |
+
"BIGSTORE_REF",
|
| 867 |
+
"COSMO_BINARY_REFERENCE"
|
| 868 |
+
],
|
| 869 |
+
"enumDescriptions": [
|
| 870 |
+
"# gdata.* are outside protos with mising documentation",
|
| 871 |
+
"# gdata.* are outside protos with mising documentation",
|
| 872 |
+
"# gdata.* are outside protos with mising documentation",
|
| 873 |
+
"# gdata.* are outside protos with mising documentation",
|
| 874 |
+
"# gdata.* are outside protos with mising documentation"
|
| 875 |
+
],
|
| 876 |
+
"type": "string"
|
| 877 |
+
},
|
| 878 |
+
"sha1Hash": {
|
| 879 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 880 |
+
"format": "byte",
|
| 881 |
+
"type": "string"
|
| 882 |
+
}
|
| 883 |
+
},
|
| 884 |
+
"type": "object"
|
| 885 |
+
},
|
| 886 |
+
"ContentTypeInfo": {
|
| 887 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 888 |
+
"id": "ContentTypeInfo",
|
| 889 |
+
"properties": {
|
| 890 |
+
"bestGuess": {
|
| 891 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 892 |
+
"type": "string"
|
| 893 |
+
},
|
| 894 |
+
"fromBytes": {
|
| 895 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 896 |
+
"type": "string"
|
| 897 |
+
},
|
| 898 |
+
"fromFileName": {
|
| 899 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 900 |
+
"type": "string"
|
| 901 |
+
},
|
| 902 |
+
"fromHeader": {
|
| 903 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 904 |
+
"type": "string"
|
| 905 |
+
},
|
| 906 |
+
"fromUrlPath": {
|
| 907 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 908 |
+
"type": "string"
|
| 909 |
+
}
|
| 910 |
+
},
|
| 911 |
+
"type": "object"
|
| 912 |
+
},
|
| 913 |
+
"CreateAttachmentRequest": {
|
| 914 |
+
"description": "The request message for the CreateAttachment endpoint.",
|
| 915 |
+
"id": "CreateAttachmentRequest",
|
| 916 |
+
"properties": {
|
| 917 |
+
"attachment": {
|
| 918 |
+
"$ref": "Attachment",
|
| 919 |
+
"description": "Required. The attachment to be created."
|
| 920 |
+
}
|
| 921 |
+
},
|
| 922 |
+
"type": "object"
|
| 923 |
+
},
|
| 924 |
+
"DiffChecksumsResponse": {
|
| 925 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 926 |
+
"id": "DiffChecksumsResponse",
|
| 927 |
+
"properties": {
|
| 928 |
+
"checksumsLocation": {
|
| 929 |
+
"$ref": "CompositeMedia",
|
| 930 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 931 |
+
},
|
| 932 |
+
"chunkSizeBytes": {
|
| 933 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 934 |
+
"format": "int64",
|
| 935 |
+
"type": "string"
|
| 936 |
+
},
|
| 937 |
+
"objectLocation": {
|
| 938 |
+
"$ref": "CompositeMedia",
|
| 939 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 940 |
+
},
|
| 941 |
+
"objectSizeBytes": {
|
| 942 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 943 |
+
"format": "int64",
|
| 944 |
+
"type": "string"
|
| 945 |
+
},
|
| 946 |
+
"objectVersion": {
|
| 947 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 948 |
+
"type": "string"
|
| 949 |
+
}
|
| 950 |
+
},
|
| 951 |
+
"type": "object"
|
| 952 |
+
},
|
| 953 |
+
"DiffDownloadResponse": {
|
| 954 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 955 |
+
"id": "DiffDownloadResponse",
|
| 956 |
+
"properties": {
|
| 957 |
+
"objectLocation": {
|
| 958 |
+
"$ref": "CompositeMedia",
|
| 959 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 960 |
+
}
|
| 961 |
+
},
|
| 962 |
+
"type": "object"
|
| 963 |
+
},
|
| 964 |
+
"DiffUploadRequest": {
|
| 965 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 966 |
+
"id": "DiffUploadRequest",
|
| 967 |
+
"properties": {
|
| 968 |
+
"checksumsInfo": {
|
| 969 |
+
"$ref": "CompositeMedia",
|
| 970 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 971 |
+
},
|
| 972 |
+
"objectInfo": {
|
| 973 |
+
"$ref": "CompositeMedia",
|
| 974 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 975 |
+
},
|
| 976 |
+
"objectVersion": {
|
| 977 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 978 |
+
"type": "string"
|
| 979 |
+
}
|
| 980 |
+
},
|
| 981 |
+
"type": "object"
|
| 982 |
+
},
|
| 983 |
+
"DiffUploadResponse": {
|
| 984 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 985 |
+
"id": "DiffUploadResponse",
|
| 986 |
+
"properties": {
|
| 987 |
+
"objectVersion": {
|
| 988 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 989 |
+
"type": "string"
|
| 990 |
+
},
|
| 991 |
+
"originalObject": {
|
| 992 |
+
"$ref": "CompositeMedia",
|
| 993 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 994 |
+
}
|
| 995 |
+
},
|
| 996 |
+
"type": "object"
|
| 997 |
+
},
|
| 998 |
+
"DiffVersionResponse": {
|
| 999 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1000 |
+
"id": "DiffVersionResponse",
|
| 1001 |
+
"properties": {
|
| 1002 |
+
"objectSizeBytes": {
|
| 1003 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1004 |
+
"format": "int64",
|
| 1005 |
+
"type": "string"
|
| 1006 |
+
},
|
| 1007 |
+
"objectVersion": {
|
| 1008 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1009 |
+
"type": "string"
|
| 1010 |
+
}
|
| 1011 |
+
},
|
| 1012 |
+
"type": "object"
|
| 1013 |
+
},
|
| 1014 |
+
"DownloadParameters": {
|
| 1015 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1016 |
+
"id": "DownloadParameters",
|
| 1017 |
+
"properties": {
|
| 1018 |
+
"allowGzipCompression": {
|
| 1019 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1020 |
+
"type": "boolean"
|
| 1021 |
+
},
|
| 1022 |
+
"ignoreRange": {
|
| 1023 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1024 |
+
"type": "boolean"
|
| 1025 |
+
}
|
| 1026 |
+
},
|
| 1027 |
+
"type": "object"
|
| 1028 |
+
},
|
| 1029 |
+
"EscalateCaseRequest": {
|
| 1030 |
+
"description": "The request message for the EscalateCase endpoint.",
|
| 1031 |
+
"id": "EscalateCaseRequest",
|
| 1032 |
+
"properties": {
|
| 1033 |
+
"escalation": {
|
| 1034 |
+
"$ref": "Escalation",
|
| 1035 |
+
"description": "The escalation information to be sent with the escalation request."
|
| 1036 |
+
}
|
| 1037 |
+
},
|
| 1038 |
+
"type": "object"
|
| 1039 |
+
},
|
| 1040 |
+
"Escalation": {
|
| 1041 |
+
"description": "An escalation of a support case.",
|
| 1042 |
+
"id": "Escalation",
|
| 1043 |
+
"properties": {
|
| 1044 |
+
"justification": {
|
| 1045 |
+
"description": "Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated.",
|
| 1046 |
+
"type": "string"
|
| 1047 |
+
},
|
| 1048 |
+
"reason": {
|
| 1049 |
+
"description": "Required. The reason why the Case is being escalated.",
|
| 1050 |
+
"enum": [
|
| 1051 |
+
"REASON_UNSPECIFIED",
|
| 1052 |
+
"RESOLUTION_TIME",
|
| 1053 |
+
"TECHNICAL_EXPERTISE",
|
| 1054 |
+
"BUSINESS_IMPACT"
|
| 1055 |
+
],
|
| 1056 |
+
"enumDescriptions": [
|
| 1057 |
+
"The escalation reason is in an unknown state or has not been specified.",
|
| 1058 |
+
"The case is taking too long to resolve.",
|
| 1059 |
+
"The support agent does not have the expertise required to successfully resolve the issue.",
|
| 1060 |
+
"The issue is having a significant business impact."
|
| 1061 |
+
],
|
| 1062 |
+
"type": "string"
|
| 1063 |
+
}
|
| 1064 |
+
},
|
| 1065 |
+
"type": "object"
|
| 1066 |
+
},
|
| 1067 |
+
"ListAttachmentsResponse": {
|
| 1068 |
+
"description": "The response message for the ListAttachments endpoint.",
|
| 1069 |
+
"id": "ListAttachmentsResponse",
|
| 1070 |
+
"properties": {
|
| 1071 |
+
"attachments": {
|
| 1072 |
+
"description": "The list of attachments associated with a case.",
|
| 1073 |
+
"items": {
|
| 1074 |
+
"$ref": "Attachment"
|
| 1075 |
+
},
|
| 1076 |
+
"type": "array"
|
| 1077 |
+
},
|
| 1078 |
+
"nextPageToken": {
|
| 1079 |
+
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve.",
|
| 1080 |
+
"type": "string"
|
| 1081 |
+
}
|
| 1082 |
+
},
|
| 1083 |
+
"type": "object"
|
| 1084 |
+
},
|
| 1085 |
+
"ListCasesResponse": {
|
| 1086 |
+
"description": "The response message for the ListCases endpoint.",
|
| 1087 |
+
"id": "ListCasesResponse",
|
| 1088 |
+
"properties": {
|
| 1089 |
+
"cases": {
|
| 1090 |
+
"description": "The list of cases associated with the parent after any filters have been applied.",
|
| 1091 |
+
"items": {
|
| 1092 |
+
"$ref": "Case"
|
| 1093 |
+
},
|
| 1094 |
+
"type": "array"
|
| 1095 |
+
},
|
| 1096 |
+
"nextPageToken": {
|
| 1097 |
+
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.list` requests. If unspecified, there are no more results to retrieve.",
|
| 1098 |
+
"type": "string"
|
| 1099 |
+
}
|
| 1100 |
+
},
|
| 1101 |
+
"type": "object"
|
| 1102 |
+
},
|
| 1103 |
+
"ListCommentsResponse": {
|
| 1104 |
+
"description": "The response message for the ListComments endpoint.",
|
| 1105 |
+
"id": "ListCommentsResponse",
|
| 1106 |
+
"properties": {
|
| 1107 |
+
"comments": {
|
| 1108 |
+
"description": "List of the comments associated with the case.",
|
| 1109 |
+
"items": {
|
| 1110 |
+
"$ref": "Comment"
|
| 1111 |
+
},
|
| 1112 |
+
"type": "array"
|
| 1113 |
+
},
|
| 1114 |
+
"nextPageToken": {
|
| 1115 |
+
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve.",
|
| 1116 |
+
"type": "string"
|
| 1117 |
+
}
|
| 1118 |
+
},
|
| 1119 |
+
"type": "object"
|
| 1120 |
+
},
|
| 1121 |
+
"Media": {
|
| 1122 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1123 |
+
"id": "Media",
|
| 1124 |
+
"properties": {
|
| 1125 |
+
"algorithm": {
|
| 1126 |
+
"deprecated": true,
|
| 1127 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1128 |
+
"type": "string"
|
| 1129 |
+
},
|
| 1130 |
+
"bigstoreObjectRef": {
|
| 1131 |
+
"deprecated": true,
|
| 1132 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1133 |
+
"format": "byte",
|
| 1134 |
+
"type": "string"
|
| 1135 |
+
},
|
| 1136 |
+
"blobRef": {
|
| 1137 |
+
"deprecated": true,
|
| 1138 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1139 |
+
"format": "byte",
|
| 1140 |
+
"type": "string"
|
| 1141 |
+
},
|
| 1142 |
+
"blobstore2Info": {
|
| 1143 |
+
"$ref": "Blobstore2Info",
|
| 1144 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1145 |
+
},
|
| 1146 |
+
"compositeMedia": {
|
| 1147 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1148 |
+
"items": {
|
| 1149 |
+
"$ref": "CompositeMedia"
|
| 1150 |
+
},
|
| 1151 |
+
"type": "array"
|
| 1152 |
+
},
|
| 1153 |
+
"contentType": {
|
| 1154 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1155 |
+
"type": "string"
|
| 1156 |
+
},
|
| 1157 |
+
"contentTypeInfo": {
|
| 1158 |
+
"$ref": "ContentTypeInfo",
|
| 1159 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1160 |
+
},
|
| 1161 |
+
"cosmoBinaryReference": {
|
| 1162 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1163 |
+
"format": "byte",
|
| 1164 |
+
"type": "string"
|
| 1165 |
+
},
|
| 1166 |
+
"crc32cHash": {
|
| 1167 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1168 |
+
"format": "uint32",
|
| 1169 |
+
"type": "integer"
|
| 1170 |
+
},
|
| 1171 |
+
"diffChecksumsResponse": {
|
| 1172 |
+
"$ref": "DiffChecksumsResponse",
|
| 1173 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1174 |
+
},
|
| 1175 |
+
"diffDownloadResponse": {
|
| 1176 |
+
"$ref": "DiffDownloadResponse",
|
| 1177 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1178 |
+
},
|
| 1179 |
+
"diffUploadRequest": {
|
| 1180 |
+
"$ref": "DiffUploadRequest",
|
| 1181 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1182 |
+
},
|
| 1183 |
+
"diffUploadResponse": {
|
| 1184 |
+
"$ref": "DiffUploadResponse",
|
| 1185 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1186 |
+
},
|
| 1187 |
+
"diffVersionResponse": {
|
| 1188 |
+
"$ref": "DiffVersionResponse",
|
| 1189 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1190 |
+
},
|
| 1191 |
+
"downloadParameters": {
|
| 1192 |
+
"$ref": "DownloadParameters",
|
| 1193 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1194 |
+
},
|
| 1195 |
+
"filename": {
|
| 1196 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1197 |
+
"type": "string"
|
| 1198 |
+
},
|
| 1199 |
+
"hash": {
|
| 1200 |
+
"deprecated": true,
|
| 1201 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1202 |
+
"type": "string"
|
| 1203 |
+
},
|
| 1204 |
+
"hashVerified": {
|
| 1205 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1206 |
+
"type": "boolean"
|
| 1207 |
+
},
|
| 1208 |
+
"inline": {
|
| 1209 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1210 |
+
"format": "byte",
|
| 1211 |
+
"type": "string"
|
| 1212 |
+
},
|
| 1213 |
+
"isPotentialRetry": {
|
| 1214 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1215 |
+
"type": "boolean"
|
| 1216 |
+
},
|
| 1217 |
+
"length": {
|
| 1218 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1219 |
+
"format": "int64",
|
| 1220 |
+
"type": "string"
|
| 1221 |
+
},
|
| 1222 |
+
"md5Hash": {
|
| 1223 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1224 |
+
"format": "byte",
|
| 1225 |
+
"type": "string"
|
| 1226 |
+
},
|
| 1227 |
+
"mediaId": {
|
| 1228 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1229 |
+
"format": "byte",
|
| 1230 |
+
"type": "string"
|
| 1231 |
+
},
|
| 1232 |
+
"objectId": {
|
| 1233 |
+
"$ref": "ObjectId",
|
| 1234 |
+
"description": "# gdata.* are outside protos with mising documentation"
|
| 1235 |
+
},
|
| 1236 |
+
"path": {
|
| 1237 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1238 |
+
"type": "string"
|
| 1239 |
+
},
|
| 1240 |
+
"referenceType": {
|
| 1241 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1242 |
+
"enum": [
|
| 1243 |
+
"PATH",
|
| 1244 |
+
"BLOB_REF",
|
| 1245 |
+
"INLINE",
|
| 1246 |
+
"GET_MEDIA",
|
| 1247 |
+
"COMPOSITE_MEDIA",
|
| 1248 |
+
"BIGSTORE_REF",
|
| 1249 |
+
"DIFF_VERSION_RESPONSE",
|
| 1250 |
+
"DIFF_CHECKSUMS_RESPONSE",
|
| 1251 |
+
"DIFF_DOWNLOAD_RESPONSE",
|
| 1252 |
+
"DIFF_UPLOAD_REQUEST",
|
| 1253 |
+
"DIFF_UPLOAD_RESPONSE",
|
| 1254 |
+
"COSMO_BINARY_REFERENCE",
|
| 1255 |
+
"ARBITRARY_BYTES"
|
| 1256 |
+
],
|
| 1257 |
+
"enumDescriptions": [
|
| 1258 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1259 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1260 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1261 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1262 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1263 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1264 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1265 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1266 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1267 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1268 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1269 |
+
"# gdata.* are outside protos with mising documentation",
|
| 1270 |
+
"# gdata.* are outside protos with mising documentation"
|
| 1271 |
+
],
|
| 1272 |
+
"type": "string"
|
| 1273 |
+
},
|
| 1274 |
+
"sha1Hash": {
|
| 1275 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1276 |
+
"format": "byte",
|
| 1277 |
+
"type": "string"
|
| 1278 |
+
},
|
| 1279 |
+
"sha256Hash": {
|
| 1280 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1281 |
+
"format": "byte",
|
| 1282 |
+
"type": "string"
|
| 1283 |
+
},
|
| 1284 |
+
"timestamp": {
|
| 1285 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1286 |
+
"format": "uint64",
|
| 1287 |
+
"type": "string"
|
| 1288 |
+
},
|
| 1289 |
+
"token": {
|
| 1290 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1291 |
+
"type": "string"
|
| 1292 |
+
}
|
| 1293 |
+
},
|
| 1294 |
+
"type": "object"
|
| 1295 |
+
},
|
| 1296 |
+
"ObjectId": {
|
| 1297 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1298 |
+
"id": "ObjectId",
|
| 1299 |
+
"properties": {
|
| 1300 |
+
"bucketName": {
|
| 1301 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1302 |
+
"type": "string"
|
| 1303 |
+
},
|
| 1304 |
+
"generation": {
|
| 1305 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1306 |
+
"format": "int64",
|
| 1307 |
+
"type": "string"
|
| 1308 |
+
},
|
| 1309 |
+
"objectName": {
|
| 1310 |
+
"description": "# gdata.* are outside protos with mising documentation",
|
| 1311 |
+
"type": "string"
|
| 1312 |
+
}
|
| 1313 |
+
},
|
| 1314 |
+
"type": "object"
|
| 1315 |
+
},
|
| 1316 |
+
"SearchCaseClassificationsResponse": {
|
| 1317 |
+
"description": "The response message for SearchCaseClassifications endpoint.",
|
| 1318 |
+
"id": "SearchCaseClassificationsResponse",
|
| 1319 |
+
"properties": {
|
| 1320 |
+
"caseClassifications": {
|
| 1321 |
+
"description": "The classifications retrieved.",
|
| 1322 |
+
"items": {
|
| 1323 |
+
"$ref": "CaseClassification"
|
| 1324 |
+
},
|
| 1325 |
+
"type": "array"
|
| 1326 |
+
},
|
| 1327 |
+
"nextPageToken": {
|
| 1328 |
+
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `caseClassifications.list` requests. If unspecified, there are no more results to retrieve.",
|
| 1329 |
+
"type": "string"
|
| 1330 |
+
}
|
| 1331 |
+
},
|
| 1332 |
+
"type": "object"
|
| 1333 |
+
},
|
| 1334 |
+
"SearchCasesResponse": {
|
| 1335 |
+
"description": "The response message for the SearchCases endpoint.",
|
| 1336 |
+
"id": "SearchCasesResponse",
|
| 1337 |
+
"properties": {
|
| 1338 |
+
"cases": {
|
| 1339 |
+
"description": "The list of cases associated with the parent after any filters have been applied.",
|
| 1340 |
+
"items": {
|
| 1341 |
+
"$ref": "Case"
|
| 1342 |
+
},
|
| 1343 |
+
"type": "array"
|
| 1344 |
+
},
|
| 1345 |
+
"nextPageToken": {
|
| 1346 |
+
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.search` requests. If unspecified, there are no more results to retrieve.",
|
| 1347 |
+
"type": "string"
|
| 1348 |
+
}
|
| 1349 |
+
},
|
| 1350 |
+
"type": "object"
|
| 1351 |
+
},
|
| 1352 |
+
"WorkflowOperationMetadata": {
|
| 1353 |
+
"description": "Metadata about the operation. Used to lookup the current status.",
|
| 1354 |
+
"id": "WorkflowOperationMetadata",
|
| 1355 |
+
"properties": {
|
| 1356 |
+
"namespace": {
|
| 1357 |
+
"description": "The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved.",
|
| 1358 |
+
"type": "string"
|
| 1359 |
+
},
|
| 1360 |
+
"operationAction": {
|
| 1361 |
+
"description": "The type of action the operation is classified as.",
|
| 1362 |
+
"enum": [
|
| 1363 |
+
"OPERATION_ACTION_UNSPECIFIED",
|
| 1364 |
+
"CREATE_SUPPORT_ACCOUNT",
|
| 1365 |
+
"UPDATE_SUPPORT_ACCOUNT",
|
| 1366 |
+
"PURCHASE_SUPPORT_ACCOUNT"
|
| 1367 |
+
],
|
| 1368 |
+
"enumDescriptions": [
|
| 1369 |
+
"Operation action is not specified.",
|
| 1370 |
+
"Operation pertains to the creation of a new support account.",
|
| 1371 |
+
"Operation pertains to the updating of an existing support account.",
|
| 1372 |
+
"Operation pertains to the purchasing of a support plan that may either create or update a support account."
|
| 1373 |
+
],
|
| 1374 |
+
"type": "string"
|
| 1375 |
+
},
|
| 1376 |
+
"workflowOperationType": {
|
| 1377 |
+
"description": "Which version of the workflow service this operation came from.",
|
| 1378 |
+
"enum": [
|
| 1379 |
+
"UNKNOWN_OPERATION_TYPE",
|
| 1380 |
+
"WORKFLOWS_V1",
|
| 1381 |
+
"WORKFLOWS_V2"
|
| 1382 |
+
],
|
| 1383 |
+
"enumDescriptions": [
|
| 1384 |
+
"Unknown version.",
|
| 1385 |
+
"Version 1.",
|
| 1386 |
+
"Version 2."
|
| 1387 |
+
],
|
| 1388 |
+
"type": "string"
|
| 1389 |
+
}
|
| 1390 |
+
},
|
| 1391 |
+
"type": "object"
|
| 1392 |
+
}
|
| 1393 |
+
},
|
| 1394 |
+
"servicePath": "",
|
| 1395 |
+
"title": "Google Cloud Support API",
|
| 1396 |
+
"version": "v2",
|
| 1397 |
+
"version_module": true
|
| 1398 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/connectors.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/connectors.v2.json
ADDED
|
@@ -0,0 +1,2500 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://connectors.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Connectors",
|
| 15 |
+
"description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "connectors:v2",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://connectors.mtls.googleapis.com/",
|
| 26 |
+
"name": "connectors",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"projects": {
|
| 109 |
+
"resources": {
|
| 110 |
+
"locations": {
|
| 111 |
+
"resources": {
|
| 112 |
+
"connections": {
|
| 113 |
+
"methods": {
|
| 114 |
+
"checkReadiness": {
|
| 115 |
+
"description": "Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.",
|
| 116 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness",
|
| 117 |
+
"httpMethod": "GET",
|
| 118 |
+
"id": "connectors.projects.locations.connections.checkReadiness",
|
| 119 |
+
"parameterOrder": [
|
| 120 |
+
"name"
|
| 121 |
+
],
|
| 122 |
+
"parameters": {
|
| 123 |
+
"name": {
|
| 124 |
+
"location": "path",
|
| 125 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 126 |
+
"required": true,
|
| 127 |
+
"type": "string"
|
| 128 |
+
}
|
| 129 |
+
},
|
| 130 |
+
"path": "v2/{+name}:checkReadiness",
|
| 131 |
+
"response": {
|
| 132 |
+
"$ref": "CheckReadinessResponse"
|
| 133 |
+
},
|
| 134 |
+
"scopes": [
|
| 135 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 136 |
+
]
|
| 137 |
+
},
|
| 138 |
+
"checkStatus": {
|
| 139 |
+
"description": "Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not \"OK\", which indicates that ConnectionStatus itself, not the connection, failed.",
|
| 140 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus",
|
| 141 |
+
"httpMethod": "GET",
|
| 142 |
+
"id": "connectors.projects.locations.connections.checkStatus",
|
| 143 |
+
"parameterOrder": [
|
| 144 |
+
"name"
|
| 145 |
+
],
|
| 146 |
+
"parameters": {
|
| 147 |
+
"name": {
|
| 148 |
+
"location": "path",
|
| 149 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 150 |
+
"required": true,
|
| 151 |
+
"type": "string"
|
| 152 |
+
}
|
| 153 |
+
},
|
| 154 |
+
"path": "v2/{+name}:checkStatus",
|
| 155 |
+
"response": {
|
| 156 |
+
"$ref": "CheckStatusResponse"
|
| 157 |
+
},
|
| 158 |
+
"scopes": [
|
| 159 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 160 |
+
]
|
| 161 |
+
},
|
| 162 |
+
"exchangeAuthCode": {
|
| 163 |
+
"description": "ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).",
|
| 164 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode",
|
| 165 |
+
"httpMethod": "POST",
|
| 166 |
+
"id": "connectors.projects.locations.connections.exchangeAuthCode",
|
| 167 |
+
"parameterOrder": [
|
| 168 |
+
"name"
|
| 169 |
+
],
|
| 170 |
+
"parameters": {
|
| 171 |
+
"name": {
|
| 172 |
+
"location": "path",
|
| 173 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 174 |
+
"required": true,
|
| 175 |
+
"type": "string"
|
| 176 |
+
}
|
| 177 |
+
},
|
| 178 |
+
"path": "v2/{+name}:exchangeAuthCode",
|
| 179 |
+
"request": {
|
| 180 |
+
"$ref": "ExchangeAuthCodeRequest"
|
| 181 |
+
},
|
| 182 |
+
"response": {
|
| 183 |
+
"$ref": "ExchangeAuthCodeResponse"
|
| 184 |
+
},
|
| 185 |
+
"scopes": [
|
| 186 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 187 |
+
]
|
| 188 |
+
},
|
| 189 |
+
"executeSqlQuery": {
|
| 190 |
+
"description": "Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.",
|
| 191 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery",
|
| 192 |
+
"httpMethod": "POST",
|
| 193 |
+
"id": "connectors.projects.locations.connections.executeSqlQuery",
|
| 194 |
+
"parameterOrder": [
|
| 195 |
+
"connection"
|
| 196 |
+
],
|
| 197 |
+
"parameters": {
|
| 198 |
+
"connection": {
|
| 199 |
+
"description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}",
|
| 200 |
+
"location": "path",
|
| 201 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 202 |
+
"required": true,
|
| 203 |
+
"type": "string"
|
| 204 |
+
}
|
| 205 |
+
},
|
| 206 |
+
"path": "v2/{+connection}:executeSqlQuery",
|
| 207 |
+
"request": {
|
| 208 |
+
"$ref": "ExecuteSqlQueryRequest"
|
| 209 |
+
},
|
| 210 |
+
"response": {
|
| 211 |
+
"$ref": "ExecuteSqlQueryResponse"
|
| 212 |
+
},
|
| 213 |
+
"scopes": [
|
| 214 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 215 |
+
]
|
| 216 |
+
},
|
| 217 |
+
"refreshAccessToken": {
|
| 218 |
+
"description": "RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).",
|
| 219 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken",
|
| 220 |
+
"httpMethod": "POST",
|
| 221 |
+
"id": "connectors.projects.locations.connections.refreshAccessToken",
|
| 222 |
+
"parameterOrder": [
|
| 223 |
+
"name"
|
| 224 |
+
],
|
| 225 |
+
"parameters": {
|
| 226 |
+
"name": {
|
| 227 |
+
"location": "path",
|
| 228 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 229 |
+
"required": true,
|
| 230 |
+
"type": "string"
|
| 231 |
+
}
|
| 232 |
+
},
|
| 233 |
+
"path": "v2/{+name}:refreshAccessToken",
|
| 234 |
+
"request": {
|
| 235 |
+
"$ref": "RefreshAccessTokenRequest"
|
| 236 |
+
},
|
| 237 |
+
"response": {
|
| 238 |
+
"$ref": "RefreshAccessTokenResponse"
|
| 239 |
+
},
|
| 240 |
+
"scopes": [
|
| 241 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 242 |
+
]
|
| 243 |
+
}
|
| 244 |
+
},
|
| 245 |
+
"resources": {
|
| 246 |
+
"actions": {
|
| 247 |
+
"methods": {
|
| 248 |
+
"execute": {
|
| 249 |
+
"description": "Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.",
|
| 250 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute",
|
| 251 |
+
"httpMethod": "POST",
|
| 252 |
+
"id": "connectors.projects.locations.connections.actions.execute",
|
| 253 |
+
"parameterOrder": [
|
| 254 |
+
"name"
|
| 255 |
+
],
|
| 256 |
+
"parameters": {
|
| 257 |
+
"name": {
|
| 258 |
+
"description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}",
|
| 259 |
+
"location": "path",
|
| 260 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$",
|
| 261 |
+
"required": true,
|
| 262 |
+
"type": "string"
|
| 263 |
+
}
|
| 264 |
+
},
|
| 265 |
+
"path": "v2/{+name}:execute",
|
| 266 |
+
"request": {
|
| 267 |
+
"$ref": "ExecuteActionRequest"
|
| 268 |
+
},
|
| 269 |
+
"response": {
|
| 270 |
+
"$ref": "ExecuteActionResponse"
|
| 271 |
+
},
|
| 272 |
+
"scopes": [
|
| 273 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 274 |
+
]
|
| 275 |
+
},
|
| 276 |
+
"get": {
|
| 277 |
+
"description": "Gets the schema of the given action.",
|
| 278 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}",
|
| 279 |
+
"httpMethod": "GET",
|
| 280 |
+
"id": "connectors.projects.locations.connections.actions.get",
|
| 281 |
+
"parameterOrder": [
|
| 282 |
+
"name"
|
| 283 |
+
],
|
| 284 |
+
"parameters": {
|
| 285 |
+
"name": {
|
| 286 |
+
"description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}",
|
| 287 |
+
"location": "path",
|
| 288 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$",
|
| 289 |
+
"required": true,
|
| 290 |
+
"type": "string"
|
| 291 |
+
}
|
| 292 |
+
},
|
| 293 |
+
"path": "v2/{+name}",
|
| 294 |
+
"response": {
|
| 295 |
+
"$ref": "Action"
|
| 296 |
+
},
|
| 297 |
+
"scopes": [
|
| 298 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 299 |
+
]
|
| 300 |
+
},
|
| 301 |
+
"list": {
|
| 302 |
+
"description": "Gets the schema of all the actions supported by the connector.",
|
| 303 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions",
|
| 304 |
+
"httpMethod": "GET",
|
| 305 |
+
"id": "connectors.projects.locations.connections.actions.list",
|
| 306 |
+
"parameterOrder": [
|
| 307 |
+
"parent"
|
| 308 |
+
],
|
| 309 |
+
"parameters": {
|
| 310 |
+
"pageSize": {
|
| 311 |
+
"description": "Number of Actions to return. Defaults to 25.",
|
| 312 |
+
"format": "int32",
|
| 313 |
+
"location": "query",
|
| 314 |
+
"type": "integer"
|
| 315 |
+
},
|
| 316 |
+
"pageToken": {
|
| 317 |
+
"description": "Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions.",
|
| 318 |
+
"location": "query",
|
| 319 |
+
"type": "string"
|
| 320 |
+
},
|
| 321 |
+
"parent": {
|
| 322 |
+
"description": "Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}",
|
| 323 |
+
"location": "path",
|
| 324 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 325 |
+
"required": true,
|
| 326 |
+
"type": "string"
|
| 327 |
+
},
|
| 328 |
+
"view": {
|
| 329 |
+
"description": "Specifies which fields of the Action are returned in the response.",
|
| 330 |
+
"enum": [
|
| 331 |
+
"ACTION_VIEW_UNSPECIFIED",
|
| 332 |
+
"ACTION_VIEW_BASIC",
|
| 333 |
+
"ACTION_VIEW_FULL"
|
| 334 |
+
],
|
| 335 |
+
"enumDescriptions": [
|
| 336 |
+
"VIEW_UNSPECIFIED. The unset value Defaults to FULL View.",
|
| 337 |
+
"Return only action names.",
|
| 338 |
+
"Return actions with schema."
|
| 339 |
+
],
|
| 340 |
+
"location": "query",
|
| 341 |
+
"type": "string"
|
| 342 |
+
}
|
| 343 |
+
},
|
| 344 |
+
"path": "v2/{+parent}/actions",
|
| 345 |
+
"response": {
|
| 346 |
+
"$ref": "ListActionsResponse"
|
| 347 |
+
},
|
| 348 |
+
"scopes": [
|
| 349 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 350 |
+
]
|
| 351 |
+
}
|
| 352 |
+
}
|
| 353 |
+
},
|
| 354 |
+
"entityTypes": {
|
| 355 |
+
"methods": {
|
| 356 |
+
"get": {
|
| 357 |
+
"description": "Gets metadata of given entity type",
|
| 358 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}",
|
| 359 |
+
"httpMethod": "GET",
|
| 360 |
+
"id": "connectors.projects.locations.connections.entityTypes.get",
|
| 361 |
+
"parameterOrder": [
|
| 362 |
+
"name"
|
| 363 |
+
],
|
| 364 |
+
"parameters": {
|
| 365 |
+
"name": {
|
| 366 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType}",
|
| 367 |
+
"location": "path",
|
| 368 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
|
| 369 |
+
"required": true,
|
| 370 |
+
"type": "string"
|
| 371 |
+
}
|
| 372 |
+
},
|
| 373 |
+
"path": "v2/{+name}",
|
| 374 |
+
"response": {
|
| 375 |
+
"$ref": "EntityType"
|
| 376 |
+
},
|
| 377 |
+
"scopes": [
|
| 378 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 379 |
+
]
|
| 380 |
+
},
|
| 381 |
+
"list": {
|
| 382 |
+
"description": "Lists metadata related to all entity types present in the external system.",
|
| 383 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes",
|
| 384 |
+
"httpMethod": "GET",
|
| 385 |
+
"id": "connectors.projects.locations.connections.entityTypes.list",
|
| 386 |
+
"parameterOrder": [
|
| 387 |
+
"parent"
|
| 388 |
+
],
|
| 389 |
+
"parameters": {
|
| 390 |
+
"pageSize": {
|
| 391 |
+
"description": "Number of entity types to return. Defaults to 25.",
|
| 392 |
+
"format": "int32",
|
| 393 |
+
"location": "query",
|
| 394 |
+
"type": "integer"
|
| 395 |
+
},
|
| 396 |
+
"pageToken": {
|
| 397 |
+
"description": "Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.",
|
| 398 |
+
"location": "query",
|
| 399 |
+
"type": "string"
|
| 400 |
+
},
|
| 401 |
+
"parent": {
|
| 402 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}",
|
| 403 |
+
"location": "path",
|
| 404 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
| 405 |
+
"required": true,
|
| 406 |
+
"type": "string"
|
| 407 |
+
},
|
| 408 |
+
"view": {
|
| 409 |
+
"description": "Specifies which fields of the Entity Type are returned in the response.",
|
| 410 |
+
"enum": [
|
| 411 |
+
"ENTITY_TYPE_VIEW_UNSPECIFIED",
|
| 412 |
+
"ENTITY_TYPE_VIEW_BASIC",
|
| 413 |
+
"ENTITY_TYPE_VIEW_FULL"
|
| 414 |
+
],
|
| 415 |
+
"enumDescriptions": [
|
| 416 |
+
"VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.",
|
| 417 |
+
"Return only entity type names.",
|
| 418 |
+
"Return entity types with schema"
|
| 419 |
+
],
|
| 420 |
+
"location": "query",
|
| 421 |
+
"type": "string"
|
| 422 |
+
}
|
| 423 |
+
},
|
| 424 |
+
"path": "v2/{+parent}/entityTypes",
|
| 425 |
+
"response": {
|
| 426 |
+
"$ref": "ListEntityTypesResponse"
|
| 427 |
+
},
|
| 428 |
+
"scopes": [
|
| 429 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 430 |
+
]
|
| 431 |
+
}
|
| 432 |
+
},
|
| 433 |
+
"resources": {
|
| 434 |
+
"entities": {
|
| 435 |
+
"methods": {
|
| 436 |
+
"create": {
|
| 437 |
+
"description": "Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.",
|
| 438 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities",
|
| 439 |
+
"httpMethod": "POST",
|
| 440 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.create",
|
| 441 |
+
"parameterOrder": [
|
| 442 |
+
"parent"
|
| 443 |
+
],
|
| 444 |
+
"parameters": {
|
| 445 |
+
"parent": {
|
| 446 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
|
| 447 |
+
"location": "path",
|
| 448 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
|
| 449 |
+
"required": true,
|
| 450 |
+
"type": "string"
|
| 451 |
+
}
|
| 452 |
+
},
|
| 453 |
+
"path": "v2/{+parent}/entities",
|
| 454 |
+
"request": {
|
| 455 |
+
"$ref": "Entity"
|
| 456 |
+
},
|
| 457 |
+
"response": {
|
| 458 |
+
"$ref": "Entity"
|
| 459 |
+
},
|
| 460 |
+
"scopes": [
|
| 461 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 462 |
+
]
|
| 463 |
+
},
|
| 464 |
+
"delete": {
|
| 465 |
+
"description": "Deletes an existing entity row matching the entity type and entity id specified in the request.",
|
| 466 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
|
| 467 |
+
"httpMethod": "DELETE",
|
| 468 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.delete",
|
| 469 |
+
"parameterOrder": [
|
| 470 |
+
"name"
|
| 471 |
+
],
|
| 472 |
+
"parameters": {
|
| 473 |
+
"name": {
|
| 474 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
|
| 475 |
+
"location": "path",
|
| 476 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
|
| 477 |
+
"required": true,
|
| 478 |
+
"type": "string"
|
| 479 |
+
}
|
| 480 |
+
},
|
| 481 |
+
"path": "v2/{+name}",
|
| 482 |
+
"response": {
|
| 483 |
+
"$ref": "Empty"
|
| 484 |
+
},
|
| 485 |
+
"scopes": [
|
| 486 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 487 |
+
]
|
| 488 |
+
},
|
| 489 |
+
"deleteEntitiesWithConditions": {
|
| 490 |
+
"description": "Deletes entities based on conditions specified in the request and not on entity id.",
|
| 491 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions",
|
| 492 |
+
"httpMethod": "POST",
|
| 493 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.deleteEntitiesWithConditions",
|
| 494 |
+
"parameterOrder": [
|
| 495 |
+
"entityType"
|
| 496 |
+
],
|
| 497 |
+
"parameters": {
|
| 498 |
+
"conditions": {
|
| 499 |
+
"description": "Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.",
|
| 500 |
+
"location": "query",
|
| 501 |
+
"type": "string"
|
| 502 |
+
},
|
| 503 |
+
"entityType": {
|
| 504 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
|
| 505 |
+
"location": "path",
|
| 506 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
|
| 507 |
+
"required": true,
|
| 508 |
+
"type": "string"
|
| 509 |
+
}
|
| 510 |
+
},
|
| 511 |
+
"path": "v2/{+entityType}/entities:deleteEntitiesWithConditions",
|
| 512 |
+
"response": {
|
| 513 |
+
"$ref": "Empty"
|
| 514 |
+
},
|
| 515 |
+
"scopes": [
|
| 516 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 517 |
+
]
|
| 518 |
+
},
|
| 519 |
+
"get": {
|
| 520 |
+
"description": "Gets a single entity row matching the entity type and entity id specified in the request.",
|
| 521 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
|
| 522 |
+
"httpMethod": "GET",
|
| 523 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.get",
|
| 524 |
+
"parameterOrder": [
|
| 525 |
+
"name"
|
| 526 |
+
],
|
| 527 |
+
"parameters": {
|
| 528 |
+
"name": {
|
| 529 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
|
| 530 |
+
"location": "path",
|
| 531 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
|
| 532 |
+
"required": true,
|
| 533 |
+
"type": "string"
|
| 534 |
+
}
|
| 535 |
+
},
|
| 536 |
+
"path": "v2/{+name}",
|
| 537 |
+
"response": {
|
| 538 |
+
"$ref": "Entity"
|
| 539 |
+
},
|
| 540 |
+
"scopes": [
|
| 541 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 542 |
+
]
|
| 543 |
+
},
|
| 544 |
+
"list": {
|
| 545 |
+
"description": "Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.",
|
| 546 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities",
|
| 547 |
+
"httpMethod": "GET",
|
| 548 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.list",
|
| 549 |
+
"parameterOrder": [
|
| 550 |
+
"parent"
|
| 551 |
+
],
|
| 552 |
+
"parameters": {
|
| 553 |
+
"conditions": {
|
| 554 |
+
"description": "Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.",
|
| 555 |
+
"location": "query",
|
| 556 |
+
"type": "string"
|
| 557 |
+
},
|
| 558 |
+
"pageSize": {
|
| 559 |
+
"description": "Number of entity rows to return. Defaults page size = 25. Max page size = 200.",
|
| 560 |
+
"format": "int32",
|
| 561 |
+
"location": "query",
|
| 562 |
+
"type": "integer"
|
| 563 |
+
},
|
| 564 |
+
"pageToken": {
|
| 565 |
+
"description": "Page token value if available from a previous request.",
|
| 566 |
+
"location": "query",
|
| 567 |
+
"type": "string"
|
| 568 |
+
},
|
| 569 |
+
"parent": {
|
| 570 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
|
| 571 |
+
"location": "path",
|
| 572 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
|
| 573 |
+
"required": true,
|
| 574 |
+
"type": "string"
|
| 575 |
+
},
|
| 576 |
+
"sortBy": {
|
| 577 |
+
"description": "List of 'sort_by' columns to use when returning the results.",
|
| 578 |
+
"location": "query",
|
| 579 |
+
"repeated": true,
|
| 580 |
+
"type": "string"
|
| 581 |
+
}
|
| 582 |
+
},
|
| 583 |
+
"path": "v2/{+parent}/entities",
|
| 584 |
+
"response": {
|
| 585 |
+
"$ref": "ListEntitiesResponse"
|
| 586 |
+
},
|
| 587 |
+
"scopes": [
|
| 588 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 589 |
+
]
|
| 590 |
+
},
|
| 591 |
+
"patch": {
|
| 592 |
+
"description": "Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.",
|
| 593 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
|
| 594 |
+
"httpMethod": "PATCH",
|
| 595 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.patch",
|
| 596 |
+
"parameterOrder": [
|
| 597 |
+
"name"
|
| 598 |
+
],
|
| 599 |
+
"parameters": {
|
| 600 |
+
"name": {
|
| 601 |
+
"description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
|
| 602 |
+
"location": "path",
|
| 603 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
|
| 604 |
+
"required": true,
|
| 605 |
+
"type": "string"
|
| 606 |
+
}
|
| 607 |
+
},
|
| 608 |
+
"path": "v2/{+name}",
|
| 609 |
+
"request": {
|
| 610 |
+
"$ref": "Entity"
|
| 611 |
+
},
|
| 612 |
+
"response": {
|
| 613 |
+
"$ref": "Entity"
|
| 614 |
+
},
|
| 615 |
+
"scopes": [
|
| 616 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 617 |
+
]
|
| 618 |
+
},
|
| 619 |
+
"updateEntitiesWithConditions": {
|
| 620 |
+
"description": "Updates entities based on conditions specified in the request and not on entity id.",
|
| 621 |
+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions",
|
| 622 |
+
"httpMethod": "POST",
|
| 623 |
+
"id": "connectors.projects.locations.connections.entityTypes.entities.updateEntitiesWithConditions",
|
| 624 |
+
"parameterOrder": [
|
| 625 |
+
"entityType"
|
| 626 |
+
],
|
| 627 |
+
"parameters": {
|
| 628 |
+
"conditions": {
|
| 629 |
+
"description": "Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.",
|
| 630 |
+
"location": "query",
|
| 631 |
+
"type": "string"
|
| 632 |
+
},
|
| 633 |
+
"entityType": {
|
| 634 |
+
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
|
| 635 |
+
"location": "path",
|
| 636 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
|
| 637 |
+
"required": true,
|
| 638 |
+
"type": "string"
|
| 639 |
+
}
|
| 640 |
+
},
|
| 641 |
+
"path": "v2/{+entityType}/entities:updateEntitiesWithConditions",
|
| 642 |
+
"request": {
|
| 643 |
+
"$ref": "Entity"
|
| 644 |
+
},
|
| 645 |
+
"response": {
|
| 646 |
+
"$ref": "UpdateEntitiesWithConditionsResponse"
|
| 647 |
+
},
|
| 648 |
+
"scopes": [
|
| 649 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 650 |
+
]
|
| 651 |
+
}
|
| 652 |
+
}
|
| 653 |
+
}
|
| 654 |
+
}
|
| 655 |
+
}
|
| 656 |
+
}
|
| 657 |
+
}
|
| 658 |
+
}
|
| 659 |
+
}
|
| 660 |
+
}
|
| 661 |
+
}
|
| 662 |
+
},
|
| 663 |
+
"revision": "20241015",
|
| 664 |
+
"rootUrl": "https://connectors.googleapis.com/",
|
| 665 |
+
"schemas": {
|
| 666 |
+
"AccessCredentials": {
|
| 667 |
+
"description": "AccessCredentials includes the OAuth access token, and the other fields returned along with it.",
|
| 668 |
+
"id": "AccessCredentials",
|
| 669 |
+
"properties": {
|
| 670 |
+
"accessToken": {
|
| 671 |
+
"description": "OAuth access token.",
|
| 672 |
+
"type": "string"
|
| 673 |
+
},
|
| 674 |
+
"expiresIn": {
|
| 675 |
+
"description": "Duration till the access token expires.",
|
| 676 |
+
"format": "google-duration",
|
| 677 |
+
"type": "string"
|
| 678 |
+
},
|
| 679 |
+
"refreshToken": {
|
| 680 |
+
"description": "OAuth refresh token.",
|
| 681 |
+
"type": "string"
|
| 682 |
+
}
|
| 683 |
+
},
|
| 684 |
+
"type": "object"
|
| 685 |
+
},
|
| 686 |
+
"Action": {
|
| 687 |
+
"description": "Action message contains metadata information about a single action present in the external system.",
|
| 688 |
+
"id": "Action",
|
| 689 |
+
"properties": {
|
| 690 |
+
"description": {
|
| 691 |
+
"description": "Brief Description of action",
|
| 692 |
+
"type": "string"
|
| 693 |
+
},
|
| 694 |
+
"displayName": {
|
| 695 |
+
"description": "Display Name of action to be shown on client side",
|
| 696 |
+
"type": "string"
|
| 697 |
+
},
|
| 698 |
+
"inputJsonSchema": {
|
| 699 |
+
"$ref": "JsonSchema",
|
| 700 |
+
"description": "JsonSchema representation of this actions's input schema"
|
| 701 |
+
},
|
| 702 |
+
"inputParameters": {
|
| 703 |
+
"description": "List containing input parameter metadata.",
|
| 704 |
+
"items": {
|
| 705 |
+
"$ref": "InputParameter"
|
| 706 |
+
},
|
| 707 |
+
"type": "array"
|
| 708 |
+
},
|
| 709 |
+
"name": {
|
| 710 |
+
"description": "Name of the action.",
|
| 711 |
+
"type": "string"
|
| 712 |
+
},
|
| 713 |
+
"resultJsonSchema": {
|
| 714 |
+
"$ref": "JsonSchema",
|
| 715 |
+
"description": "JsonSchema representation of this actions's result schema"
|
| 716 |
+
},
|
| 717 |
+
"resultMetadata": {
|
| 718 |
+
"description": "List containing the metadata of result fields.",
|
| 719 |
+
"items": {
|
| 720 |
+
"$ref": "ResultMetadata"
|
| 721 |
+
},
|
| 722 |
+
"type": "array"
|
| 723 |
+
}
|
| 724 |
+
},
|
| 725 |
+
"type": "object"
|
| 726 |
+
},
|
| 727 |
+
"AuthCodeData": {
|
| 728 |
+
"description": "AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens.",
|
| 729 |
+
"id": "AuthCodeData",
|
| 730 |
+
"properties": {
|
| 731 |
+
"authCode": {
|
| 732 |
+
"description": "OAuth authorization code.",
|
| 733 |
+
"type": "string"
|
| 734 |
+
},
|
| 735 |
+
"pkceVerifier": {
|
| 736 |
+
"description": "OAuth PKCE verifier, needed if PKCE is enabled for this particular connection.",
|
| 737 |
+
"type": "string"
|
| 738 |
+
},
|
| 739 |
+
"redirectUri": {
|
| 740 |
+
"description": "OAuth redirect URI passed in during the auth code flow, required by some OAuth backends.",
|
| 741 |
+
"type": "string"
|
| 742 |
+
}
|
| 743 |
+
},
|
| 744 |
+
"type": "object"
|
| 745 |
+
},
|
| 746 |
+
"CheckReadinessResponse": {
|
| 747 |
+
"description": "Response containing status of the connector for readiness prober.",
|
| 748 |
+
"id": "CheckReadinessResponse",
|
| 749 |
+
"properties": {
|
| 750 |
+
"status": {
|
| 751 |
+
"type": "string"
|
| 752 |
+
}
|
| 753 |
+
},
|
| 754 |
+
"type": "object"
|
| 755 |
+
},
|
| 756 |
+
"CheckStatusResponse": {
|
| 757 |
+
"description": "The status of the connector.",
|
| 758 |
+
"id": "CheckStatusResponse",
|
| 759 |
+
"properties": {
|
| 760 |
+
"description": {
|
| 761 |
+
"description": "When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.",
|
| 762 |
+
"type": "string"
|
| 763 |
+
},
|
| 764 |
+
"state": {
|
| 765 |
+
"description": "State of the connector.",
|
| 766 |
+
"enum": [
|
| 767 |
+
"STATE_UNSPECIFIED",
|
| 768 |
+
"ACTIVE",
|
| 769 |
+
"ERROR",
|
| 770 |
+
"AUTH_ERROR"
|
| 771 |
+
],
|
| 772 |
+
"enumDescriptions": [
|
| 773 |
+
"State unspecified.",
|
| 774 |
+
"The connector is active and ready to process runtime requests. This can also mean that from the connector's perspective, the connector is not in an error state and should be able to process runtime requests successfully.",
|
| 775 |
+
"The connector is in an error state and cannot process runtime requests. An example reason would be that the connection container has some network issues that prevent outbound requests from being sent.",
|
| 776 |
+
"This is a more specific error state that the developers can opt to use when the connector is facing auth-related errors caused by auth configuration not present, invalid auth credentials, etc."
|
| 777 |
+
],
|
| 778 |
+
"type": "string"
|
| 779 |
+
}
|
| 780 |
+
},
|
| 781 |
+
"type": "object"
|
| 782 |
+
},
|
| 783 |
+
"DailyCycle": {
|
| 784 |
+
"description": "Time window specified for daily operations.",
|
| 785 |
+
"id": "DailyCycle",
|
| 786 |
+
"properties": {
|
| 787 |
+
"duration": {
|
| 788 |
+
"description": "Output only. Duration of the time window, set by service producer.",
|
| 789 |
+
"format": "google-duration",
|
| 790 |
+
"type": "string"
|
| 791 |
+
},
|
| 792 |
+
"startTime": {
|
| 793 |
+
"$ref": "TimeOfDay",
|
| 794 |
+
"description": "Time within the day to start the operations."
|
| 795 |
+
}
|
| 796 |
+
},
|
| 797 |
+
"type": "object"
|
| 798 |
+
},
|
| 799 |
+
"Date": {
|
| 800 |
+
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
|
| 801 |
+
"id": "Date",
|
| 802 |
+
"properties": {
|
| 803 |
+
"day": {
|
| 804 |
+
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
|
| 805 |
+
"format": "int32",
|
| 806 |
+
"type": "integer"
|
| 807 |
+
},
|
| 808 |
+
"month": {
|
| 809 |
+
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
|
| 810 |
+
"format": "int32",
|
| 811 |
+
"type": "integer"
|
| 812 |
+
},
|
| 813 |
+
"year": {
|
| 814 |
+
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
|
| 815 |
+
"format": "int32",
|
| 816 |
+
"type": "integer"
|
| 817 |
+
}
|
| 818 |
+
},
|
| 819 |
+
"type": "object"
|
| 820 |
+
},
|
| 821 |
+
"DenyMaintenancePeriod": {
|
| 822 |
+
"description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.",
|
| 823 |
+
"id": "DenyMaintenancePeriod",
|
| 824 |
+
"properties": {
|
| 825 |
+
"endDate": {
|
| 826 |
+
"$ref": "Date",
|
| 827 |
+
"description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end."
|
| 828 |
+
},
|
| 829 |
+
"startDate": {
|
| 830 |
+
"$ref": "Date",
|
| 831 |
+
"description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start."
|
| 832 |
+
},
|
| 833 |
+
"time": {
|
| 834 |
+
"$ref": "TimeOfDay",
|
| 835 |
+
"description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC"
|
| 836 |
+
}
|
| 837 |
+
},
|
| 838 |
+
"type": "object"
|
| 839 |
+
},
|
| 840 |
+
"Empty": {
|
| 841 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 842 |
+
"id": "Empty",
|
| 843 |
+
"properties": {},
|
| 844 |
+
"type": "object"
|
| 845 |
+
},
|
| 846 |
+
"Entity": {
|
| 847 |
+
"description": "'Entity row'/ 'Entity' refers to a single row of an entity type.",
|
| 848 |
+
"id": "Entity",
|
| 849 |
+
"properties": {
|
| 850 |
+
"fields": {
|
| 851 |
+
"additionalProperties": {
|
| 852 |
+
"type": "any"
|
| 853 |
+
},
|
| 854 |
+
"description": "Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.",
|
| 855 |
+
"type": "object"
|
| 856 |
+
},
|
| 857 |
+
"name": {
|
| 858 |
+
"description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
|
| 859 |
+
"readOnly": true,
|
| 860 |
+
"type": "string"
|
| 861 |
+
}
|
| 862 |
+
},
|
| 863 |
+
"type": "object"
|
| 864 |
+
},
|
| 865 |
+
"EntityType": {
|
| 866 |
+
"description": "EntityType message contains metadata information about a single entity type present in the external system.",
|
| 867 |
+
"id": "EntityType",
|
| 868 |
+
"properties": {
|
| 869 |
+
"fields": {
|
| 870 |
+
"description": "List containing metadata information about each field of the entity type.",
|
| 871 |
+
"items": {
|
| 872 |
+
"$ref": "Field"
|
| 873 |
+
},
|
| 874 |
+
"type": "array"
|
| 875 |
+
},
|
| 876 |
+
"jsonSchema": {
|
| 877 |
+
"$ref": "JsonSchema",
|
| 878 |
+
"description": "JsonSchema representation of this entity's schema"
|
| 879 |
+
},
|
| 880 |
+
"name": {
|
| 881 |
+
"description": "The name of the entity type.",
|
| 882 |
+
"type": "string"
|
| 883 |
+
},
|
| 884 |
+
"operations": {
|
| 885 |
+
"items": {
|
| 886 |
+
"enum": [
|
| 887 |
+
"OPERATION_UNSPECIFIED",
|
| 888 |
+
"LIST",
|
| 889 |
+
"GET",
|
| 890 |
+
"CREATE",
|
| 891 |
+
"UPDATE",
|
| 892 |
+
"DELETE"
|
| 893 |
+
],
|
| 894 |
+
"enumDescriptions": [
|
| 895 |
+
"Operation unspecified.",
|
| 896 |
+
"This operation means entity type supports LIST method.",
|
| 897 |
+
"This operation means entity type supports GET method.",
|
| 898 |
+
"This operation means entity type supports CREATE method.",
|
| 899 |
+
"This operation means entity type supports UPDATE method.",
|
| 900 |
+
"This operation means entity type supports DELETE method."
|
| 901 |
+
],
|
| 902 |
+
"type": "string"
|
| 903 |
+
},
|
| 904 |
+
"type": "array"
|
| 905 |
+
}
|
| 906 |
+
},
|
| 907 |
+
"type": "object"
|
| 908 |
+
},
|
| 909 |
+
"ExchangeAuthCodeRequest": {
|
| 910 |
+
"description": "ExchangeAuthCodeRequest currently includes the auth code data.",
|
| 911 |
+
"id": "ExchangeAuthCodeRequest",
|
| 912 |
+
"properties": {
|
| 913 |
+
"authCodeData": {
|
| 914 |
+
"$ref": "AuthCodeData",
|
| 915 |
+
"description": "Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager."
|
| 916 |
+
}
|
| 917 |
+
},
|
| 918 |
+
"type": "object"
|
| 919 |
+
},
|
| 920 |
+
"ExchangeAuthCodeResponse": {
|
| 921 |
+
"description": "ExchangeAuthCodeResponse includes the returned access token and its associated credentials.",
|
| 922 |
+
"id": "ExchangeAuthCodeResponse",
|
| 923 |
+
"properties": {
|
| 924 |
+
"accessCredentials": {
|
| 925 |
+
"$ref": "AccessCredentials"
|
| 926 |
+
}
|
| 927 |
+
},
|
| 928 |
+
"type": "object"
|
| 929 |
+
},
|
| 930 |
+
"ExecuteActionRequest": {
|
| 931 |
+
"description": "Request message for ActionService.ExecuteAction",
|
| 932 |
+
"id": "ExecuteActionRequest",
|
| 933 |
+
"properties": {
|
| 934 |
+
"parameters": {
|
| 935 |
+
"additionalProperties": {
|
| 936 |
+
"description": "Properties of the object.",
|
| 937 |
+
"type": "any"
|
| 938 |
+
},
|
| 939 |
+
"description": "Parameters for executing the action. The parameters can be key/value pairs or nested structs.",
|
| 940 |
+
"type": "object"
|
| 941 |
+
}
|
| 942 |
+
},
|
| 943 |
+
"type": "object"
|
| 944 |
+
},
|
| 945 |
+
"ExecuteActionResponse": {
|
| 946 |
+
"description": "Response message for ActionService.ExecuteAction",
|
| 947 |
+
"id": "ExecuteActionResponse",
|
| 948 |
+
"properties": {
|
| 949 |
+
"results": {
|
| 950 |
+
"description": "In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results': [{'key': 'value'}, ...] }",
|
| 951 |
+
"items": {
|
| 952 |
+
"additionalProperties": {
|
| 953 |
+
"description": "Properties of the object.",
|
| 954 |
+
"type": "any"
|
| 955 |
+
},
|
| 956 |
+
"type": "object"
|
| 957 |
+
},
|
| 958 |
+
"type": "array"
|
| 959 |
+
}
|
| 960 |
+
},
|
| 961 |
+
"type": "object"
|
| 962 |
+
},
|
| 963 |
+
"ExecuteSqlQueryRequest": {
|
| 964 |
+
"description": "An execute sql query request containing the query and the connection to execute it on.",
|
| 965 |
+
"id": "ExecuteSqlQueryRequest",
|
| 966 |
+
"properties": {
|
| 967 |
+
"query": {
|
| 968 |
+
"$ref": "Query",
|
| 969 |
+
"description": "Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems."
|
| 970 |
+
}
|
| 971 |
+
},
|
| 972 |
+
"type": "object"
|
| 973 |
+
},
|
| 974 |
+
"ExecuteSqlQueryResponse": {
|
| 975 |
+
"description": "A response returned by the connection after executing the sql query.",
|
| 976 |
+
"id": "ExecuteSqlQueryResponse",
|
| 977 |
+
"properties": {
|
| 978 |
+
"results": {
|
| 979 |
+
"description": "In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the 'results' Struct list - \"results\": [ { \"field1\": \"val1\", \"field2\": \"val2\",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists.",
|
| 980 |
+
"items": {
|
| 981 |
+
"additionalProperties": {
|
| 982 |
+
"description": "Properties of the object.",
|
| 983 |
+
"type": "any"
|
| 984 |
+
},
|
| 985 |
+
"type": "object"
|
| 986 |
+
},
|
| 987 |
+
"type": "array"
|
| 988 |
+
}
|
| 989 |
+
},
|
| 990 |
+
"type": "object"
|
| 991 |
+
},
|
| 992 |
+
"Field": {
|
| 993 |
+
"description": "Message contains EntityType's Field metadata.",
|
| 994 |
+
"id": "Field",
|
| 995 |
+
"properties": {
|
| 996 |
+
"additionalDetails": {
|
| 997 |
+
"additionalProperties": {
|
| 998 |
+
"description": "Properties of the object.",
|
| 999 |
+
"type": "any"
|
| 1000 |
+
},
|
| 1001 |
+
"description": "The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.",
|
| 1002 |
+
"type": "object"
|
| 1003 |
+
},
|
| 1004 |
+
"dataType": {
|
| 1005 |
+
"description": "The data type of the Field.",
|
| 1006 |
+
"enum": [
|
| 1007 |
+
"DATA_TYPE_UNSPECIFIED",
|
| 1008 |
+
"INT",
|
| 1009 |
+
"SMALLINT",
|
| 1010 |
+
"DOUBLE",
|
| 1011 |
+
"DATE",
|
| 1012 |
+
"DATETIME",
|
| 1013 |
+
"TIME",
|
| 1014 |
+
"STRING",
|
| 1015 |
+
"LONG",
|
| 1016 |
+
"BOOLEAN",
|
| 1017 |
+
"DECIMAL",
|
| 1018 |
+
"UUID",
|
| 1019 |
+
"BLOB",
|
| 1020 |
+
"BIT",
|
| 1021 |
+
"TINYINT",
|
| 1022 |
+
"INTEGER",
|
| 1023 |
+
"BIGINT",
|
| 1024 |
+
"FLOAT",
|
| 1025 |
+
"REAL",
|
| 1026 |
+
"NUMERIC",
|
| 1027 |
+
"CHAR",
|
| 1028 |
+
"VARCHAR",
|
| 1029 |
+
"LONGVARCHAR",
|
| 1030 |
+
"TIMESTAMP",
|
| 1031 |
+
"NCHAR",
|
| 1032 |
+
"NVARCHAR",
|
| 1033 |
+
"LONGNVARCHAR",
|
| 1034 |
+
"NULL",
|
| 1035 |
+
"OTHER",
|
| 1036 |
+
"JAVA_OBJECT",
|
| 1037 |
+
"DISTINCT",
|
| 1038 |
+
"STRUCT",
|
| 1039 |
+
"ARRAY",
|
| 1040 |
+
"CLOB",
|
| 1041 |
+
"REF",
|
| 1042 |
+
"DATALINK",
|
| 1043 |
+
"ROWID",
|
| 1044 |
+
"BINARY",
|
| 1045 |
+
"VARBINARY",
|
| 1046 |
+
"LONGVARBINARY",
|
| 1047 |
+
"NCLOB",
|
| 1048 |
+
"SQLXML",
|
| 1049 |
+
"REF_CURSOR",
|
| 1050 |
+
"TIME_WITH_TIMEZONE",
|
| 1051 |
+
"TIMESTAMP_WITH_TIMEZONE"
|
| 1052 |
+
],
|
| 1053 |
+
"enumDeprecated": [
|
| 1054 |
+
false,
|
| 1055 |
+
true,
|
| 1056 |
+
false,
|
| 1057 |
+
false,
|
| 1058 |
+
false,
|
| 1059 |
+
true,
|
| 1060 |
+
false,
|
| 1061 |
+
true,
|
| 1062 |
+
true,
|
| 1063 |
+
false,
|
| 1064 |
+
false,
|
| 1065 |
+
true,
|
| 1066 |
+
false,
|
| 1067 |
+
false,
|
| 1068 |
+
false,
|
| 1069 |
+
false,
|
| 1070 |
+
false,
|
| 1071 |
+
false,
|
| 1072 |
+
false,
|
| 1073 |
+
false,
|
| 1074 |
+
false,
|
| 1075 |
+
false,
|
| 1076 |
+
false,
|
| 1077 |
+
false,
|
| 1078 |
+
false,
|
| 1079 |
+
false,
|
| 1080 |
+
false,
|
| 1081 |
+
false,
|
| 1082 |
+
false,
|
| 1083 |
+
false,
|
| 1084 |
+
false,
|
| 1085 |
+
false,
|
| 1086 |
+
false,
|
| 1087 |
+
false,
|
| 1088 |
+
false,
|
| 1089 |
+
false,
|
| 1090 |
+
false,
|
| 1091 |
+
false,
|
| 1092 |
+
false,
|
| 1093 |
+
false,
|
| 1094 |
+
false,
|
| 1095 |
+
false,
|
| 1096 |
+
false,
|
| 1097 |
+
false,
|
| 1098 |
+
false
|
| 1099 |
+
],
|
| 1100 |
+
"enumDescriptions": [
|
| 1101 |
+
"Datatype unspecified.",
|
| 1102 |
+
"Deprecated Int type, use INTEGER type instead.",
|
| 1103 |
+
"Small int type.",
|
| 1104 |
+
"Double type.",
|
| 1105 |
+
"Date type.",
|
| 1106 |
+
"Deprecated Datetime type.",
|
| 1107 |
+
"Time type.",
|
| 1108 |
+
"Deprecated string type, use VARCHAR type instead.",
|
| 1109 |
+
"Deprecated Long type, use BIGINT type instead.",
|
| 1110 |
+
"Boolean type.",
|
| 1111 |
+
"Decimal type.",
|
| 1112 |
+
"Deprecated UUID type, use VARCHAR instead.",
|
| 1113 |
+
"Blob type.",
|
| 1114 |
+
"Bit type.",
|
| 1115 |
+
"Tiny int type.",
|
| 1116 |
+
"Integer type.",
|
| 1117 |
+
"Big int type.",
|
| 1118 |
+
"Float type.",
|
| 1119 |
+
"Real type.",
|
| 1120 |
+
"Numeric type.",
|
| 1121 |
+
"Char type.",
|
| 1122 |
+
"Varchar type.",
|
| 1123 |
+
"Long varchar type.",
|
| 1124 |
+
"Timestamp type.",
|
| 1125 |
+
"Nchar type.",
|
| 1126 |
+
"Nvarchar type.",
|
| 1127 |
+
"Long Nvarchar type.",
|
| 1128 |
+
"Null type.",
|
| 1129 |
+
"Other type.",
|
| 1130 |
+
"Java object type.",
|
| 1131 |
+
"Distinct type keyword.",
|
| 1132 |
+
"Struct type.",
|
| 1133 |
+
"Array type.",
|
| 1134 |
+
"Clob type.",
|
| 1135 |
+
"Ref type.",
|
| 1136 |
+
"Datalink type.",
|
| 1137 |
+
"Row ID type.",
|
| 1138 |
+
"Binary type.",
|
| 1139 |
+
"Varbinary type.",
|
| 1140 |
+
"Long Varbinary type.",
|
| 1141 |
+
"Nclob type.",
|
| 1142 |
+
"SQLXML type.",
|
| 1143 |
+
"Ref_cursor type.",
|
| 1144 |
+
"Time with timezone type.",
|
| 1145 |
+
"Timestamp with timezone type."
|
| 1146 |
+
],
|
| 1147 |
+
"type": "string"
|
| 1148 |
+
},
|
| 1149 |
+
"defaultValue": {
|
| 1150 |
+
"description": "The following field specifies the default value of the Field provided by the external system if a value is not provided.",
|
| 1151 |
+
"type": "any"
|
| 1152 |
+
},
|
| 1153 |
+
"description": {
|
| 1154 |
+
"description": "A brief description of the Field.",
|
| 1155 |
+
"type": "string"
|
| 1156 |
+
},
|
| 1157 |
+
"jsonSchema": {
|
| 1158 |
+
"$ref": "JsonSchema",
|
| 1159 |
+
"description": "JsonSchema of the field, applicable only if field is of type `STRUCT`"
|
| 1160 |
+
},
|
| 1161 |
+
"key": {
|
| 1162 |
+
"description": "The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.",
|
| 1163 |
+
"type": "boolean"
|
| 1164 |
+
},
|
| 1165 |
+
"name": {
|
| 1166 |
+
"description": "Name of the Field.",
|
| 1167 |
+
"type": "string"
|
| 1168 |
+
},
|
| 1169 |
+
"nullable": {
|
| 1170 |
+
"description": "Specifies whether a null value is allowed.",
|
| 1171 |
+
"type": "boolean"
|
| 1172 |
+
},
|
| 1173 |
+
"reference": {
|
| 1174 |
+
"$ref": "Reference",
|
| 1175 |
+
"description": "Reference captures the association between two different entity types. Value links to the reference of another entity type."
|
| 1176 |
+
}
|
| 1177 |
+
},
|
| 1178 |
+
"type": "object"
|
| 1179 |
+
},
|
| 1180 |
+
"InputParameter": {
|
| 1181 |
+
"description": "Input Parameter message contains metadata about the parameters required for executing an Action.",
|
| 1182 |
+
"id": "InputParameter",
|
| 1183 |
+
"properties": {
|
| 1184 |
+
"additionalDetails": {
|
| 1185 |
+
"additionalProperties": {
|
| 1186 |
+
"description": "Properties of the object.",
|
| 1187 |
+
"type": "any"
|
| 1188 |
+
},
|
| 1189 |
+
"description": "The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.",
|
| 1190 |
+
"type": "object"
|
| 1191 |
+
},
|
| 1192 |
+
"dataType": {
|
| 1193 |
+
"description": "The data type of the Parameter",
|
| 1194 |
+
"enum": [
|
| 1195 |
+
"DATA_TYPE_UNSPECIFIED",
|
| 1196 |
+
"INT",
|
| 1197 |
+
"SMALLINT",
|
| 1198 |
+
"DOUBLE",
|
| 1199 |
+
"DATE",
|
| 1200 |
+
"DATETIME",
|
| 1201 |
+
"TIME",
|
| 1202 |
+
"STRING",
|
| 1203 |
+
"LONG",
|
| 1204 |
+
"BOOLEAN",
|
| 1205 |
+
"DECIMAL",
|
| 1206 |
+
"UUID",
|
| 1207 |
+
"BLOB",
|
| 1208 |
+
"BIT",
|
| 1209 |
+
"TINYINT",
|
| 1210 |
+
"INTEGER",
|
| 1211 |
+
"BIGINT",
|
| 1212 |
+
"FLOAT",
|
| 1213 |
+
"REAL",
|
| 1214 |
+
"NUMERIC",
|
| 1215 |
+
"CHAR",
|
| 1216 |
+
"VARCHAR",
|
| 1217 |
+
"LONGVARCHAR",
|
| 1218 |
+
"TIMESTAMP",
|
| 1219 |
+
"NCHAR",
|
| 1220 |
+
"NVARCHAR",
|
| 1221 |
+
"LONGNVARCHAR",
|
| 1222 |
+
"NULL",
|
| 1223 |
+
"OTHER",
|
| 1224 |
+
"JAVA_OBJECT",
|
| 1225 |
+
"DISTINCT",
|
| 1226 |
+
"STRUCT",
|
| 1227 |
+
"ARRAY",
|
| 1228 |
+
"CLOB",
|
| 1229 |
+
"REF",
|
| 1230 |
+
"DATALINK",
|
| 1231 |
+
"ROWID",
|
| 1232 |
+
"BINARY",
|
| 1233 |
+
"VARBINARY",
|
| 1234 |
+
"LONGVARBINARY",
|
| 1235 |
+
"NCLOB",
|
| 1236 |
+
"SQLXML",
|
| 1237 |
+
"REF_CURSOR",
|
| 1238 |
+
"TIME_WITH_TIMEZONE",
|
| 1239 |
+
"TIMESTAMP_WITH_TIMEZONE"
|
| 1240 |
+
],
|
| 1241 |
+
"enumDeprecated": [
|
| 1242 |
+
false,
|
| 1243 |
+
true,
|
| 1244 |
+
false,
|
| 1245 |
+
false,
|
| 1246 |
+
false,
|
| 1247 |
+
true,
|
| 1248 |
+
false,
|
| 1249 |
+
true,
|
| 1250 |
+
true,
|
| 1251 |
+
false,
|
| 1252 |
+
false,
|
| 1253 |
+
true,
|
| 1254 |
+
false,
|
| 1255 |
+
false,
|
| 1256 |
+
false,
|
| 1257 |
+
false,
|
| 1258 |
+
false,
|
| 1259 |
+
false,
|
| 1260 |
+
false,
|
| 1261 |
+
false,
|
| 1262 |
+
false,
|
| 1263 |
+
false,
|
| 1264 |
+
false,
|
| 1265 |
+
false,
|
| 1266 |
+
false,
|
| 1267 |
+
false,
|
| 1268 |
+
false,
|
| 1269 |
+
false,
|
| 1270 |
+
false,
|
| 1271 |
+
false,
|
| 1272 |
+
false,
|
| 1273 |
+
false,
|
| 1274 |
+
false,
|
| 1275 |
+
false,
|
| 1276 |
+
false,
|
| 1277 |
+
false,
|
| 1278 |
+
false,
|
| 1279 |
+
false,
|
| 1280 |
+
false,
|
| 1281 |
+
false,
|
| 1282 |
+
false,
|
| 1283 |
+
false,
|
| 1284 |
+
false,
|
| 1285 |
+
false,
|
| 1286 |
+
false
|
| 1287 |
+
],
|
| 1288 |
+
"enumDescriptions": [
|
| 1289 |
+
"Datatype unspecified.",
|
| 1290 |
+
"Deprecated Int type, use INTEGER type instead.",
|
| 1291 |
+
"Small int type.",
|
| 1292 |
+
"Double type.",
|
| 1293 |
+
"Date type.",
|
| 1294 |
+
"Deprecated Datetime type.",
|
| 1295 |
+
"Time type.",
|
| 1296 |
+
"Deprecated string type, use VARCHAR type instead.",
|
| 1297 |
+
"Deprecated Long type, use BIGINT type instead.",
|
| 1298 |
+
"Boolean type.",
|
| 1299 |
+
"Decimal type.",
|
| 1300 |
+
"Deprecated UUID type, use VARCHAR instead.",
|
| 1301 |
+
"Blob type.",
|
| 1302 |
+
"Bit type.",
|
| 1303 |
+
"Tiny int type.",
|
| 1304 |
+
"Integer type.",
|
| 1305 |
+
"Big int type.",
|
| 1306 |
+
"Float type.",
|
| 1307 |
+
"Real type.",
|
| 1308 |
+
"Numeric type.",
|
| 1309 |
+
"Char type.",
|
| 1310 |
+
"Varchar type.",
|
| 1311 |
+
"Long varchar type.",
|
| 1312 |
+
"Timestamp type.",
|
| 1313 |
+
"Nchar type.",
|
| 1314 |
+
"Nvarchar type.",
|
| 1315 |
+
"Long Nvarchar type.",
|
| 1316 |
+
"Null type.",
|
| 1317 |
+
"Other type.",
|
| 1318 |
+
"Java object type.",
|
| 1319 |
+
"Distinct type keyword.",
|
| 1320 |
+
"Struct type.",
|
| 1321 |
+
"Array type.",
|
| 1322 |
+
"Clob type.",
|
| 1323 |
+
"Ref type.",
|
| 1324 |
+
"Datalink type.",
|
| 1325 |
+
"Row ID type.",
|
| 1326 |
+
"Binary type.",
|
| 1327 |
+
"Varbinary type.",
|
| 1328 |
+
"Long Varbinary type.",
|
| 1329 |
+
"Nclob type.",
|
| 1330 |
+
"SQLXML type.",
|
| 1331 |
+
"Ref_cursor type.",
|
| 1332 |
+
"Time with timezone type.",
|
| 1333 |
+
"Timestamp with timezone type."
|
| 1334 |
+
],
|
| 1335 |
+
"type": "string"
|
| 1336 |
+
},
|
| 1337 |
+
"defaultValue": {
|
| 1338 |
+
"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.",
|
| 1339 |
+
"type": "any"
|
| 1340 |
+
},
|
| 1341 |
+
"description": {
|
| 1342 |
+
"description": "A brief description of the Parameter.",
|
| 1343 |
+
"type": "string"
|
| 1344 |
+
},
|
| 1345 |
+
"jsonSchema": {
|
| 1346 |
+
"$ref": "JsonSchema",
|
| 1347 |
+
"description": "JsonSchema of the parameter, applicable only if parameter is of type `STRUCT`"
|
| 1348 |
+
},
|
| 1349 |
+
"name": {
|
| 1350 |
+
"description": "Name of the Parameter.",
|
| 1351 |
+
"type": "string"
|
| 1352 |
+
},
|
| 1353 |
+
"nullable": {
|
| 1354 |
+
"description": "Specifies whether a null value is allowed.",
|
| 1355 |
+
"type": "boolean"
|
| 1356 |
+
}
|
| 1357 |
+
},
|
| 1358 |
+
"type": "object"
|
| 1359 |
+
},
|
| 1360 |
+
"Instance": {
|
| 1361 |
+
"description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange",
|
| 1362 |
+
"id": "Instance",
|
| 1363 |
+
"properties": {
|
| 1364 |
+
"consumerDefinedName": {
|
| 1365 |
+
"description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).",
|
| 1366 |
+
"type": "string"
|
| 1367 |
+
},
|
| 1368 |
+
"createTime": {
|
| 1369 |
+
"description": "Output only. Timestamp when the resource was created.",
|
| 1370 |
+
"format": "google-datetime",
|
| 1371 |
+
"readOnly": true,
|
| 1372 |
+
"type": "string"
|
| 1373 |
+
},
|
| 1374 |
+
"instanceType": {
|
| 1375 |
+
"description": "Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.",
|
| 1376 |
+
"type": "string"
|
| 1377 |
+
},
|
| 1378 |
+
"labels": {
|
| 1379 |
+
"additionalProperties": {
|
| 1380 |
+
"type": "string"
|
| 1381 |
+
},
|
| 1382 |
+
"description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.",
|
| 1383 |
+
"type": "object"
|
| 1384 |
+
},
|
| 1385 |
+
"maintenancePolicyNames": {
|
| 1386 |
+
"additionalProperties": {
|
| 1387 |
+
"type": "string"
|
| 1388 |
+
},
|
| 1389 |
+
"description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set.",
|
| 1390 |
+
"type": "object"
|
| 1391 |
+
},
|
| 1392 |
+
"maintenanceSchedules": {
|
| 1393 |
+
"additionalProperties": {
|
| 1394 |
+
"$ref": "MaintenanceSchedule"
|
| 1395 |
+
},
|
| 1396 |
+
"description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.",
|
| 1397 |
+
"type": "object"
|
| 1398 |
+
},
|
| 1399 |
+
"maintenanceSettings": {
|
| 1400 |
+
"$ref": "MaintenanceSettings",
|
| 1401 |
+
"description": "Optional. The MaintenanceSettings associated with instance."
|
| 1402 |
+
},
|
| 1403 |
+
"name": {
|
| 1404 |
+
"description": "Unique name of the resource. It uses the form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.",
|
| 1405 |
+
"type": "string"
|
| 1406 |
+
},
|
| 1407 |
+
"notificationParameters": {
|
| 1408 |
+
"additionalProperties": {
|
| 1409 |
+
"$ref": "NotificationParameter"
|
| 1410 |
+
},
|
| 1411 |
+
"description": "Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.",
|
| 1412 |
+
"type": "object"
|
| 1413 |
+
},
|
| 1414 |
+
"producerMetadata": {
|
| 1415 |
+
"additionalProperties": {
|
| 1416 |
+
"type": "string"
|
| 1417 |
+
},
|
| 1418 |
+
"description": "Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.",
|
| 1419 |
+
"readOnly": true,
|
| 1420 |
+
"type": "object"
|
| 1421 |
+
},
|
| 1422 |
+
"provisionedResources": {
|
| 1423 |
+
"description": "Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.",
|
| 1424 |
+
"items": {
|
| 1425 |
+
"$ref": "ProvisionedResource"
|
| 1426 |
+
},
|
| 1427 |
+
"readOnly": true,
|
| 1428 |
+
"type": "array"
|
| 1429 |
+
},
|
| 1430 |
+
"slmInstanceTemplate": {
|
| 1431 |
+
"description": "Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.",
|
| 1432 |
+
"type": "string"
|
| 1433 |
+
},
|
| 1434 |
+
"sloMetadata": {
|
| 1435 |
+
"$ref": "SloMetadata",
|
| 1436 |
+
"description": "Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.",
|
| 1437 |
+
"readOnly": true
|
| 1438 |
+
},
|
| 1439 |
+
"softwareVersions": {
|
| 1440 |
+
"additionalProperties": {
|
| 1441 |
+
"type": "string"
|
| 1442 |
+
},
|
| 1443 |
+
"description": "Software versions that are used to deploy this instance. This can be mutated by rollout services.",
|
| 1444 |
+
"type": "object"
|
| 1445 |
+
},
|
| 1446 |
+
"state": {
|
| 1447 |
+
"description": "Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).",
|
| 1448 |
+
"enum": [
|
| 1449 |
+
"STATE_UNSPECIFIED",
|
| 1450 |
+
"CREATING",
|
| 1451 |
+
"READY",
|
| 1452 |
+
"UPDATING",
|
| 1453 |
+
"REPAIRING",
|
| 1454 |
+
"DELETING",
|
| 1455 |
+
"ERROR"
|
| 1456 |
+
],
|
| 1457 |
+
"enumDescriptions": [
|
| 1458 |
+
"Unspecified state.",
|
| 1459 |
+
"Instance is being created.",
|
| 1460 |
+
"Instance has been created and is ready to use.",
|
| 1461 |
+
"Instance is being updated.",
|
| 1462 |
+
"Instance is unheathy and under repair.",
|
| 1463 |
+
"Instance is being deleted.",
|
| 1464 |
+
"Instance encountered an error and is in indeterministic state."
|
| 1465 |
+
],
|
| 1466 |
+
"readOnly": true,
|
| 1467 |
+
"type": "string"
|
| 1468 |
+
},
|
| 1469 |
+
"tenantProjectId": {
|
| 1470 |
+
"description": "Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.",
|
| 1471 |
+
"readOnly": true,
|
| 1472 |
+
"type": "string"
|
| 1473 |
+
},
|
| 1474 |
+
"updateTime": {
|
| 1475 |
+
"description": "Output only. Timestamp when the resource was last modified.",
|
| 1476 |
+
"format": "google-datetime",
|
| 1477 |
+
"readOnly": true,
|
| 1478 |
+
"type": "string"
|
| 1479 |
+
}
|
| 1480 |
+
},
|
| 1481 |
+
"type": "object"
|
| 1482 |
+
},
|
| 1483 |
+
"JsonSchema": {
|
| 1484 |
+
"description": "JsonSchema representation of schema metadata",
|
| 1485 |
+
"id": "JsonSchema",
|
| 1486 |
+
"properties": {
|
| 1487 |
+
"additionalDetails": {
|
| 1488 |
+
"additionalProperties": {
|
| 1489 |
+
"description": "Properties of the object.",
|
| 1490 |
+
"type": "any"
|
| 1491 |
+
},
|
| 1492 |
+
"description": "Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema",
|
| 1493 |
+
"type": "object"
|
| 1494 |
+
},
|
| 1495 |
+
"default": {
|
| 1496 |
+
"description": "The default value of the field or object described by this schema.",
|
| 1497 |
+
"type": "any"
|
| 1498 |
+
},
|
| 1499 |
+
"description": {
|
| 1500 |
+
"description": "A description of this schema.",
|
| 1501 |
+
"type": "string"
|
| 1502 |
+
},
|
| 1503 |
+
"enum": {
|
| 1504 |
+
"description": "Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values",
|
| 1505 |
+
"items": {
|
| 1506 |
+
"type": "any"
|
| 1507 |
+
},
|
| 1508 |
+
"type": "array"
|
| 1509 |
+
},
|
| 1510 |
+
"format": {
|
| 1511 |
+
"description": "Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format",
|
| 1512 |
+
"type": "string"
|
| 1513 |
+
},
|
| 1514 |
+
"items": {
|
| 1515 |
+
"$ref": "JsonSchema",
|
| 1516 |
+
"description": "Schema that applies to array values, applicable only if this is of type `array`."
|
| 1517 |
+
},
|
| 1518 |
+
"jdbcType": {
|
| 1519 |
+
"description": "JDBC datatype of the field.",
|
| 1520 |
+
"enum": [
|
| 1521 |
+
"DATA_TYPE_UNSPECIFIED",
|
| 1522 |
+
"INT",
|
| 1523 |
+
"SMALLINT",
|
| 1524 |
+
"DOUBLE",
|
| 1525 |
+
"DATE",
|
| 1526 |
+
"DATETIME",
|
| 1527 |
+
"TIME",
|
| 1528 |
+
"STRING",
|
| 1529 |
+
"LONG",
|
| 1530 |
+
"BOOLEAN",
|
| 1531 |
+
"DECIMAL",
|
| 1532 |
+
"UUID",
|
| 1533 |
+
"BLOB",
|
| 1534 |
+
"BIT",
|
| 1535 |
+
"TINYINT",
|
| 1536 |
+
"INTEGER",
|
| 1537 |
+
"BIGINT",
|
| 1538 |
+
"FLOAT",
|
| 1539 |
+
"REAL",
|
| 1540 |
+
"NUMERIC",
|
| 1541 |
+
"CHAR",
|
| 1542 |
+
"VARCHAR",
|
| 1543 |
+
"LONGVARCHAR",
|
| 1544 |
+
"TIMESTAMP",
|
| 1545 |
+
"NCHAR",
|
| 1546 |
+
"NVARCHAR",
|
| 1547 |
+
"LONGNVARCHAR",
|
| 1548 |
+
"NULL",
|
| 1549 |
+
"OTHER",
|
| 1550 |
+
"JAVA_OBJECT",
|
| 1551 |
+
"DISTINCT",
|
| 1552 |
+
"STRUCT",
|
| 1553 |
+
"ARRAY",
|
| 1554 |
+
"CLOB",
|
| 1555 |
+
"REF",
|
| 1556 |
+
"DATALINK",
|
| 1557 |
+
"ROWID",
|
| 1558 |
+
"BINARY",
|
| 1559 |
+
"VARBINARY",
|
| 1560 |
+
"LONGVARBINARY",
|
| 1561 |
+
"NCLOB",
|
| 1562 |
+
"SQLXML",
|
| 1563 |
+
"REF_CURSOR",
|
| 1564 |
+
"TIME_WITH_TIMEZONE",
|
| 1565 |
+
"TIMESTAMP_WITH_TIMEZONE"
|
| 1566 |
+
],
|
| 1567 |
+
"enumDeprecated": [
|
| 1568 |
+
false,
|
| 1569 |
+
true,
|
| 1570 |
+
false,
|
| 1571 |
+
false,
|
| 1572 |
+
false,
|
| 1573 |
+
true,
|
| 1574 |
+
false,
|
| 1575 |
+
true,
|
| 1576 |
+
true,
|
| 1577 |
+
false,
|
| 1578 |
+
false,
|
| 1579 |
+
true,
|
| 1580 |
+
false,
|
| 1581 |
+
false,
|
| 1582 |
+
false,
|
| 1583 |
+
false,
|
| 1584 |
+
false,
|
| 1585 |
+
false,
|
| 1586 |
+
false,
|
| 1587 |
+
false,
|
| 1588 |
+
false,
|
| 1589 |
+
false,
|
| 1590 |
+
false,
|
| 1591 |
+
false,
|
| 1592 |
+
false,
|
| 1593 |
+
false,
|
| 1594 |
+
false,
|
| 1595 |
+
false,
|
| 1596 |
+
false,
|
| 1597 |
+
false,
|
| 1598 |
+
false,
|
| 1599 |
+
false,
|
| 1600 |
+
false,
|
| 1601 |
+
false,
|
| 1602 |
+
false,
|
| 1603 |
+
false,
|
| 1604 |
+
false,
|
| 1605 |
+
false,
|
| 1606 |
+
false,
|
| 1607 |
+
false,
|
| 1608 |
+
false,
|
| 1609 |
+
false,
|
| 1610 |
+
false,
|
| 1611 |
+
false,
|
| 1612 |
+
false
|
| 1613 |
+
],
|
| 1614 |
+
"enumDescriptions": [
|
| 1615 |
+
"Datatype unspecified.",
|
| 1616 |
+
"Deprecated Int type, use INTEGER type instead.",
|
| 1617 |
+
"Small int type.",
|
| 1618 |
+
"Double type.",
|
| 1619 |
+
"Date type.",
|
| 1620 |
+
"Deprecated Datetime type.",
|
| 1621 |
+
"Time type.",
|
| 1622 |
+
"Deprecated string type, use VARCHAR type instead.",
|
| 1623 |
+
"Deprecated Long type, use BIGINT type instead.",
|
| 1624 |
+
"Boolean type.",
|
| 1625 |
+
"Decimal type.",
|
| 1626 |
+
"Deprecated UUID type, use VARCHAR instead.",
|
| 1627 |
+
"Blob type.",
|
| 1628 |
+
"Bit type.",
|
| 1629 |
+
"Tiny int type.",
|
| 1630 |
+
"Integer type.",
|
| 1631 |
+
"Big int type.",
|
| 1632 |
+
"Float type.",
|
| 1633 |
+
"Real type.",
|
| 1634 |
+
"Numeric type.",
|
| 1635 |
+
"Char type.",
|
| 1636 |
+
"Varchar type.",
|
| 1637 |
+
"Long varchar type.",
|
| 1638 |
+
"Timestamp type.",
|
| 1639 |
+
"Nchar type.",
|
| 1640 |
+
"Nvarchar type.",
|
| 1641 |
+
"Long Nvarchar type.",
|
| 1642 |
+
"Null type.",
|
| 1643 |
+
"Other type.",
|
| 1644 |
+
"Java object type.",
|
| 1645 |
+
"Distinct type keyword.",
|
| 1646 |
+
"Struct type.",
|
| 1647 |
+
"Array type.",
|
| 1648 |
+
"Clob type.",
|
| 1649 |
+
"Ref type.",
|
| 1650 |
+
"Datalink type.",
|
| 1651 |
+
"Row ID type.",
|
| 1652 |
+
"Binary type.",
|
| 1653 |
+
"Varbinary type.",
|
| 1654 |
+
"Long Varbinary type.",
|
| 1655 |
+
"Nclob type.",
|
| 1656 |
+
"SQLXML type.",
|
| 1657 |
+
"Ref_cursor type.",
|
| 1658 |
+
"Time with timezone type.",
|
| 1659 |
+
"Timestamp with timezone type."
|
| 1660 |
+
],
|
| 1661 |
+
"type": "string"
|
| 1662 |
+
},
|
| 1663 |
+
"properties": {
|
| 1664 |
+
"additionalProperties": {
|
| 1665 |
+
"$ref": "JsonSchema"
|
| 1666 |
+
},
|
| 1667 |
+
"description": "The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property",
|
| 1668 |
+
"type": "object"
|
| 1669 |
+
},
|
| 1670 |
+
"required": {
|
| 1671 |
+
"description": "Whether this property is required.",
|
| 1672 |
+
"items": {
|
| 1673 |
+
"type": "string"
|
| 1674 |
+
},
|
| 1675 |
+
"type": "array"
|
| 1676 |
+
},
|
| 1677 |
+
"type": {
|
| 1678 |
+
"description": "JSON Schema Validation: A Vocabulary for Structural Validation of JSON",
|
| 1679 |
+
"items": {
|
| 1680 |
+
"type": "string"
|
| 1681 |
+
},
|
| 1682 |
+
"type": "array"
|
| 1683 |
+
}
|
| 1684 |
+
},
|
| 1685 |
+
"type": "object"
|
| 1686 |
+
},
|
| 1687 |
+
"ListActionsResponse": {
|
| 1688 |
+
"description": "Response message for ActionService.ListActions",
|
| 1689 |
+
"id": "ListActionsResponse",
|
| 1690 |
+
"properties": {
|
| 1691 |
+
"actions": {
|
| 1692 |
+
"description": "List of action metadata.",
|
| 1693 |
+
"items": {
|
| 1694 |
+
"$ref": "Action"
|
| 1695 |
+
},
|
| 1696 |
+
"type": "array"
|
| 1697 |
+
},
|
| 1698 |
+
"nextPageToken": {
|
| 1699 |
+
"description": "Next page token if more actions available.",
|
| 1700 |
+
"type": "string"
|
| 1701 |
+
},
|
| 1702 |
+
"unsupportedActionNames": {
|
| 1703 |
+
"description": "List of actions which contain unsupported Datatypes. Check datatype.proto for more information.",
|
| 1704 |
+
"items": {
|
| 1705 |
+
"type": "string"
|
| 1706 |
+
},
|
| 1707 |
+
"type": "array"
|
| 1708 |
+
}
|
| 1709 |
+
},
|
| 1710 |
+
"type": "object"
|
| 1711 |
+
},
|
| 1712 |
+
"ListEntitiesResponse": {
|
| 1713 |
+
"description": "Response message for EntityService.ListEntities",
|
| 1714 |
+
"id": "ListEntitiesResponse",
|
| 1715 |
+
"properties": {
|
| 1716 |
+
"entities": {
|
| 1717 |
+
"description": "List containing entity rows.",
|
| 1718 |
+
"items": {
|
| 1719 |
+
"$ref": "Entity"
|
| 1720 |
+
},
|
| 1721 |
+
"type": "array"
|
| 1722 |
+
},
|
| 1723 |
+
"nextPageToken": {
|
| 1724 |
+
"description": "Next page token if more records are available.",
|
| 1725 |
+
"type": "string"
|
| 1726 |
+
}
|
| 1727 |
+
},
|
| 1728 |
+
"type": "object"
|
| 1729 |
+
},
|
| 1730 |
+
"ListEntityTypesResponse": {
|
| 1731 |
+
"description": "Response message for EntityService.ListEntityTypes",
|
| 1732 |
+
"id": "ListEntityTypesResponse",
|
| 1733 |
+
"properties": {
|
| 1734 |
+
"nextPageToken": {
|
| 1735 |
+
"description": "Next page token if more entity types available.",
|
| 1736 |
+
"type": "string"
|
| 1737 |
+
},
|
| 1738 |
+
"types": {
|
| 1739 |
+
"description": "List of metadata related to all entity types.",
|
| 1740 |
+
"items": {
|
| 1741 |
+
"$ref": "EntityType"
|
| 1742 |
+
},
|
| 1743 |
+
"type": "array"
|
| 1744 |
+
},
|
| 1745 |
+
"unsupportedTypeNames": {
|
| 1746 |
+
"description": "List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information.",
|
| 1747 |
+
"items": {
|
| 1748 |
+
"type": "string"
|
| 1749 |
+
},
|
| 1750 |
+
"type": "array"
|
| 1751 |
+
}
|
| 1752 |
+
},
|
| 1753 |
+
"type": "object"
|
| 1754 |
+
},
|
| 1755 |
+
"MaintenancePolicy": {
|
| 1756 |
+
"description": "Defines policies to service maintenance events.",
|
| 1757 |
+
"id": "MaintenancePolicy",
|
| 1758 |
+
"properties": {
|
| 1759 |
+
"createTime": {
|
| 1760 |
+
"description": "Output only. The time when the resource was created.",
|
| 1761 |
+
"format": "google-datetime",
|
| 1762 |
+
"type": "string"
|
| 1763 |
+
},
|
| 1764 |
+
"description": {
|
| 1765 |
+
"description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.",
|
| 1766 |
+
"type": "string"
|
| 1767 |
+
},
|
| 1768 |
+
"labels": {
|
| 1769 |
+
"additionalProperties": {
|
| 1770 |
+
"type": "string"
|
| 1771 |
+
},
|
| 1772 |
+
"description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.",
|
| 1773 |
+
"type": "object"
|
| 1774 |
+
},
|
| 1775 |
+
"name": {
|
| 1776 |
+
"description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.",
|
| 1777 |
+
"type": "string"
|
| 1778 |
+
},
|
| 1779 |
+
"state": {
|
| 1780 |
+
"description": "Optional. The state of the policy.",
|
| 1781 |
+
"enum": [
|
| 1782 |
+
"STATE_UNSPECIFIED",
|
| 1783 |
+
"READY",
|
| 1784 |
+
"DELETING"
|
| 1785 |
+
],
|
| 1786 |
+
"enumDescriptions": [
|
| 1787 |
+
"Unspecified state.",
|
| 1788 |
+
"Resource is ready to be used.",
|
| 1789 |
+
"Resource is being deleted. It can no longer be attached to instances."
|
| 1790 |
+
],
|
| 1791 |
+
"type": "string"
|
| 1792 |
+
},
|
| 1793 |
+
"updatePolicy": {
|
| 1794 |
+
"$ref": "UpdatePolicy",
|
| 1795 |
+
"description": "Maintenance policy applicable to instance update."
|
| 1796 |
+
},
|
| 1797 |
+
"updateTime": {
|
| 1798 |
+
"description": "Output only. The time when the resource was updated.",
|
| 1799 |
+
"format": "google-datetime",
|
| 1800 |
+
"type": "string"
|
| 1801 |
+
}
|
| 1802 |
+
},
|
| 1803 |
+
"type": "object"
|
| 1804 |
+
},
|
| 1805 |
+
"MaintenanceSchedule": {
|
| 1806 |
+
"description": "Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule",
|
| 1807 |
+
"id": "MaintenanceSchedule",
|
| 1808 |
+
"properties": {
|
| 1809 |
+
"canReschedule": {
|
| 1810 |
+
"deprecated": true,
|
| 1811 |
+
"description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.",
|
| 1812 |
+
"type": "boolean"
|
| 1813 |
+
},
|
| 1814 |
+
"endTime": {
|
| 1815 |
+
"description": "The scheduled end time for the maintenance.",
|
| 1816 |
+
"format": "google-datetime",
|
| 1817 |
+
"type": "string"
|
| 1818 |
+
},
|
| 1819 |
+
"rolloutManagementPolicy": {
|
| 1820 |
+
"description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.",
|
| 1821 |
+
"type": "string"
|
| 1822 |
+
},
|
| 1823 |
+
"scheduleDeadlineTime": {
|
| 1824 |
+
"description": "schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline.",
|
| 1825 |
+
"format": "google-datetime",
|
| 1826 |
+
"type": "string"
|
| 1827 |
+
},
|
| 1828 |
+
"startTime": {
|
| 1829 |
+
"description": "The scheduled start time for the maintenance.",
|
| 1830 |
+
"format": "google-datetime",
|
| 1831 |
+
"type": "string"
|
| 1832 |
+
}
|
| 1833 |
+
},
|
| 1834 |
+
"type": "object"
|
| 1835 |
+
},
|
| 1836 |
+
"MaintenanceSettings": {
|
| 1837 |
+
"description": "Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.",
|
| 1838 |
+
"id": "MaintenanceSettings",
|
| 1839 |
+
"properties": {
|
| 1840 |
+
"exclude": {
|
| 1841 |
+
"description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.",
|
| 1842 |
+
"type": "boolean"
|
| 1843 |
+
},
|
| 1844 |
+
"isRollback": {
|
| 1845 |
+
"description": "Optional. If the update call is triggered from rollback, set the value as true.",
|
| 1846 |
+
"type": "boolean"
|
| 1847 |
+
},
|
| 1848 |
+
"maintenancePolicies": {
|
| 1849 |
+
"additionalProperties": {
|
| 1850 |
+
"$ref": "MaintenancePolicy"
|
| 1851 |
+
},
|
| 1852 |
+
"description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name.",
|
| 1853 |
+
"type": "object"
|
| 1854 |
+
}
|
| 1855 |
+
},
|
| 1856 |
+
"type": "object"
|
| 1857 |
+
},
|
| 1858 |
+
"MaintenanceWindow": {
|
| 1859 |
+
"description": "MaintenanceWindow definition.",
|
| 1860 |
+
"id": "MaintenanceWindow",
|
| 1861 |
+
"properties": {
|
| 1862 |
+
"dailyCycle": {
|
| 1863 |
+
"$ref": "DailyCycle",
|
| 1864 |
+
"description": "Daily cycle."
|
| 1865 |
+
},
|
| 1866 |
+
"weeklyCycle": {
|
| 1867 |
+
"$ref": "WeeklyCycle",
|
| 1868 |
+
"description": "Weekly cycle."
|
| 1869 |
+
}
|
| 1870 |
+
},
|
| 1871 |
+
"type": "object"
|
| 1872 |
+
},
|
| 1873 |
+
"NodeSloMetadata": {
|
| 1874 |
+
"description": "Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.",
|
| 1875 |
+
"id": "NodeSloMetadata",
|
| 1876 |
+
"properties": {
|
| 1877 |
+
"location": {
|
| 1878 |
+
"description": "The location of the node, if different from instance location.",
|
| 1879 |
+
"type": "string"
|
| 1880 |
+
},
|
| 1881 |
+
"nodeId": {
|
| 1882 |
+
"description": "The id of the node. This should be equal to SaasInstanceNode.node_id.",
|
| 1883 |
+
"type": "string"
|
| 1884 |
+
},
|
| 1885 |
+
"perSliEligibility": {
|
| 1886 |
+
"$ref": "PerSliSloEligibility",
|
| 1887 |
+
"description": "If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs."
|
| 1888 |
+
}
|
| 1889 |
+
},
|
| 1890 |
+
"type": "object"
|
| 1891 |
+
},
|
| 1892 |
+
"NotificationParameter": {
|
| 1893 |
+
"description": "Contains notification related data.",
|
| 1894 |
+
"id": "NotificationParameter",
|
| 1895 |
+
"properties": {
|
| 1896 |
+
"values": {
|
| 1897 |
+
"description": "Optional. Array of string values. e.g. instance's replica information.",
|
| 1898 |
+
"items": {
|
| 1899 |
+
"type": "string"
|
| 1900 |
+
},
|
| 1901 |
+
"type": "array"
|
| 1902 |
+
}
|
| 1903 |
+
},
|
| 1904 |
+
"type": "object"
|
| 1905 |
+
},
|
| 1906 |
+
"PerSliSloEligibility": {
|
| 1907 |
+
"description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.",
|
| 1908 |
+
"id": "PerSliSloEligibility",
|
| 1909 |
+
"properties": {
|
| 1910 |
+
"eligibilities": {
|
| 1911 |
+
"additionalProperties": {
|
| 1912 |
+
"$ref": "SloEligibility"
|
| 1913 |
+
},
|
| 1914 |
+
"description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.",
|
| 1915 |
+
"type": "object"
|
| 1916 |
+
}
|
| 1917 |
+
},
|
| 1918 |
+
"type": "object"
|
| 1919 |
+
},
|
| 1920 |
+
"ProvisionedResource": {
|
| 1921 |
+
"description": "Describes provisioned dataplane resources.",
|
| 1922 |
+
"id": "ProvisionedResource",
|
| 1923 |
+
"properties": {
|
| 1924 |
+
"resourceType": {
|
| 1925 |
+
"description": "Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.",
|
| 1926 |
+
"type": "string"
|
| 1927 |
+
},
|
| 1928 |
+
"resourceUrl": {
|
| 1929 |
+
"description": "URL identifying the resource, e.g. \"https://www.googleapis.com/compute/v1/projects/...)\".",
|
| 1930 |
+
"type": "string"
|
| 1931 |
+
}
|
| 1932 |
+
},
|
| 1933 |
+
"type": "object"
|
| 1934 |
+
},
|
| 1935 |
+
"Query": {
|
| 1936 |
+
"description": "A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: `{\"query\":\"select *\"}`.",
|
| 1937 |
+
"id": "Query",
|
| 1938 |
+
"properties": {
|
| 1939 |
+
"maxRows": {
|
| 1940 |
+
"description": "Sets the limit for the maximum number of rows returned after the query execution.",
|
| 1941 |
+
"format": "int64",
|
| 1942 |
+
"type": "string"
|
| 1943 |
+
},
|
| 1944 |
+
"query": {
|
| 1945 |
+
"description": "Required. Sql query to execute.",
|
| 1946 |
+
"type": "string"
|
| 1947 |
+
},
|
| 1948 |
+
"queryParameters": {
|
| 1949 |
+
"description": "In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter.",
|
| 1950 |
+
"items": {
|
| 1951 |
+
"$ref": "QueryParameter"
|
| 1952 |
+
},
|
| 1953 |
+
"type": "array"
|
| 1954 |
+
},
|
| 1955 |
+
"timeout": {
|
| 1956 |
+
"description": "Sets the number of seconds the driver will wait for a query to execute.",
|
| 1957 |
+
"format": "int64",
|
| 1958 |
+
"type": "string"
|
| 1959 |
+
}
|
| 1960 |
+
},
|
| 1961 |
+
"type": "object"
|
| 1962 |
+
},
|
| 1963 |
+
"QueryParameter": {
|
| 1964 |
+
"description": "Query parameter definition",
|
| 1965 |
+
"id": "QueryParameter",
|
| 1966 |
+
"properties": {
|
| 1967 |
+
"dataType": {
|
| 1968 |
+
"enum": [
|
| 1969 |
+
"DATA_TYPE_UNSPECIFIED",
|
| 1970 |
+
"INT",
|
| 1971 |
+
"SMALLINT",
|
| 1972 |
+
"DOUBLE",
|
| 1973 |
+
"DATE",
|
| 1974 |
+
"DATETIME",
|
| 1975 |
+
"TIME",
|
| 1976 |
+
"STRING",
|
| 1977 |
+
"LONG",
|
| 1978 |
+
"BOOLEAN",
|
| 1979 |
+
"DECIMAL",
|
| 1980 |
+
"UUID",
|
| 1981 |
+
"BLOB",
|
| 1982 |
+
"BIT",
|
| 1983 |
+
"TINYINT",
|
| 1984 |
+
"INTEGER",
|
| 1985 |
+
"BIGINT",
|
| 1986 |
+
"FLOAT",
|
| 1987 |
+
"REAL",
|
| 1988 |
+
"NUMERIC",
|
| 1989 |
+
"CHAR",
|
| 1990 |
+
"VARCHAR",
|
| 1991 |
+
"LONGVARCHAR",
|
| 1992 |
+
"TIMESTAMP",
|
| 1993 |
+
"NCHAR",
|
| 1994 |
+
"NVARCHAR",
|
| 1995 |
+
"LONGNVARCHAR",
|
| 1996 |
+
"NULL",
|
| 1997 |
+
"OTHER",
|
| 1998 |
+
"JAVA_OBJECT",
|
| 1999 |
+
"DISTINCT",
|
| 2000 |
+
"STRUCT",
|
| 2001 |
+
"ARRAY",
|
| 2002 |
+
"CLOB",
|
| 2003 |
+
"REF",
|
| 2004 |
+
"DATALINK",
|
| 2005 |
+
"ROWID",
|
| 2006 |
+
"BINARY",
|
| 2007 |
+
"VARBINARY",
|
| 2008 |
+
"LONGVARBINARY",
|
| 2009 |
+
"NCLOB",
|
| 2010 |
+
"SQLXML",
|
| 2011 |
+
"REF_CURSOR",
|
| 2012 |
+
"TIME_WITH_TIMEZONE",
|
| 2013 |
+
"TIMESTAMP_WITH_TIMEZONE"
|
| 2014 |
+
],
|
| 2015 |
+
"enumDeprecated": [
|
| 2016 |
+
false,
|
| 2017 |
+
true,
|
| 2018 |
+
false,
|
| 2019 |
+
false,
|
| 2020 |
+
false,
|
| 2021 |
+
true,
|
| 2022 |
+
false,
|
| 2023 |
+
true,
|
| 2024 |
+
true,
|
| 2025 |
+
false,
|
| 2026 |
+
false,
|
| 2027 |
+
true,
|
| 2028 |
+
false,
|
| 2029 |
+
false,
|
| 2030 |
+
false,
|
| 2031 |
+
false,
|
| 2032 |
+
false,
|
| 2033 |
+
false,
|
| 2034 |
+
false,
|
| 2035 |
+
false,
|
| 2036 |
+
false,
|
| 2037 |
+
false,
|
| 2038 |
+
false,
|
| 2039 |
+
false,
|
| 2040 |
+
false,
|
| 2041 |
+
false,
|
| 2042 |
+
false,
|
| 2043 |
+
false,
|
| 2044 |
+
false,
|
| 2045 |
+
false,
|
| 2046 |
+
false,
|
| 2047 |
+
false,
|
| 2048 |
+
false,
|
| 2049 |
+
false,
|
| 2050 |
+
false,
|
| 2051 |
+
false,
|
| 2052 |
+
false,
|
| 2053 |
+
false,
|
| 2054 |
+
false,
|
| 2055 |
+
false,
|
| 2056 |
+
false,
|
| 2057 |
+
false,
|
| 2058 |
+
false,
|
| 2059 |
+
false,
|
| 2060 |
+
false
|
| 2061 |
+
],
|
| 2062 |
+
"enumDescriptions": [
|
| 2063 |
+
"Datatype unspecified.",
|
| 2064 |
+
"Deprecated Int type, use INTEGER type instead.",
|
| 2065 |
+
"Small int type.",
|
| 2066 |
+
"Double type.",
|
| 2067 |
+
"Date type.",
|
| 2068 |
+
"Deprecated Datetime type.",
|
| 2069 |
+
"Time type.",
|
| 2070 |
+
"Deprecated string type, use VARCHAR type instead.",
|
| 2071 |
+
"Deprecated Long type, use BIGINT type instead.",
|
| 2072 |
+
"Boolean type.",
|
| 2073 |
+
"Decimal type.",
|
| 2074 |
+
"Deprecated UUID type, use VARCHAR instead.",
|
| 2075 |
+
"Blob type.",
|
| 2076 |
+
"Bit type.",
|
| 2077 |
+
"Tiny int type.",
|
| 2078 |
+
"Integer type.",
|
| 2079 |
+
"Big int type.",
|
| 2080 |
+
"Float type.",
|
| 2081 |
+
"Real type.",
|
| 2082 |
+
"Numeric type.",
|
| 2083 |
+
"Char type.",
|
| 2084 |
+
"Varchar type.",
|
| 2085 |
+
"Long varchar type.",
|
| 2086 |
+
"Timestamp type.",
|
| 2087 |
+
"Nchar type.",
|
| 2088 |
+
"Nvarchar type.",
|
| 2089 |
+
"Long Nvarchar type.",
|
| 2090 |
+
"Null type.",
|
| 2091 |
+
"Other type.",
|
| 2092 |
+
"Java object type.",
|
| 2093 |
+
"Distinct type keyword.",
|
| 2094 |
+
"Struct type.",
|
| 2095 |
+
"Array type.",
|
| 2096 |
+
"Clob type.",
|
| 2097 |
+
"Ref type.",
|
| 2098 |
+
"Datalink type.",
|
| 2099 |
+
"Row ID type.",
|
| 2100 |
+
"Binary type.",
|
| 2101 |
+
"Varbinary type.",
|
| 2102 |
+
"Long Varbinary type.",
|
| 2103 |
+
"Nclob type.",
|
| 2104 |
+
"SQLXML type.",
|
| 2105 |
+
"Ref_cursor type.",
|
| 2106 |
+
"Time with timezone type.",
|
| 2107 |
+
"Timestamp with timezone type."
|
| 2108 |
+
],
|
| 2109 |
+
"type": "string"
|
| 2110 |
+
},
|
| 2111 |
+
"value": {
|
| 2112 |
+
"type": "any"
|
| 2113 |
+
}
|
| 2114 |
+
},
|
| 2115 |
+
"type": "object"
|
| 2116 |
+
},
|
| 2117 |
+
"Reference": {
|
| 2118 |
+
"id": "Reference",
|
| 2119 |
+
"properties": {
|
| 2120 |
+
"name": {
|
| 2121 |
+
"description": "Name of the reference field.",
|
| 2122 |
+
"type": "string"
|
| 2123 |
+
},
|
| 2124 |
+
"type": {
|
| 2125 |
+
"description": "Name of reference entity type.",
|
| 2126 |
+
"type": "string"
|
| 2127 |
+
}
|
| 2128 |
+
},
|
| 2129 |
+
"type": "object"
|
| 2130 |
+
},
|
| 2131 |
+
"RefreshAccessTokenRequest": {
|
| 2132 |
+
"description": "RefreshAccessTokenRequest includes the refresh token.",
|
| 2133 |
+
"id": "RefreshAccessTokenRequest",
|
| 2134 |
+
"properties": {
|
| 2135 |
+
"refreshToken": {
|
| 2136 |
+
"description": "Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager.",
|
| 2137 |
+
"type": "string"
|
| 2138 |
+
}
|
| 2139 |
+
},
|
| 2140 |
+
"type": "object"
|
| 2141 |
+
},
|
| 2142 |
+
"RefreshAccessTokenResponse": {
|
| 2143 |
+
"description": "RefreshAccessTokenResponse includes the returned access token and its associated credentials.",
|
| 2144 |
+
"id": "RefreshAccessTokenResponse",
|
| 2145 |
+
"properties": {
|
| 2146 |
+
"accessCredentials": {
|
| 2147 |
+
"$ref": "AccessCredentials"
|
| 2148 |
+
}
|
| 2149 |
+
},
|
| 2150 |
+
"type": "object"
|
| 2151 |
+
},
|
| 2152 |
+
"ResultMetadata": {
|
| 2153 |
+
"description": "Result Metadata message contains metadata about the result returned after executing an Action.",
|
| 2154 |
+
"id": "ResultMetadata",
|
| 2155 |
+
"properties": {
|
| 2156 |
+
"dataType": {
|
| 2157 |
+
"description": "The data type of the metadata field",
|
| 2158 |
+
"enum": [
|
| 2159 |
+
"DATA_TYPE_UNSPECIFIED",
|
| 2160 |
+
"INT",
|
| 2161 |
+
"SMALLINT",
|
| 2162 |
+
"DOUBLE",
|
| 2163 |
+
"DATE",
|
| 2164 |
+
"DATETIME",
|
| 2165 |
+
"TIME",
|
| 2166 |
+
"STRING",
|
| 2167 |
+
"LONG",
|
| 2168 |
+
"BOOLEAN",
|
| 2169 |
+
"DECIMAL",
|
| 2170 |
+
"UUID",
|
| 2171 |
+
"BLOB",
|
| 2172 |
+
"BIT",
|
| 2173 |
+
"TINYINT",
|
| 2174 |
+
"INTEGER",
|
| 2175 |
+
"BIGINT",
|
| 2176 |
+
"FLOAT",
|
| 2177 |
+
"REAL",
|
| 2178 |
+
"NUMERIC",
|
| 2179 |
+
"CHAR",
|
| 2180 |
+
"VARCHAR",
|
| 2181 |
+
"LONGVARCHAR",
|
| 2182 |
+
"TIMESTAMP",
|
| 2183 |
+
"NCHAR",
|
| 2184 |
+
"NVARCHAR",
|
| 2185 |
+
"LONGNVARCHAR",
|
| 2186 |
+
"NULL",
|
| 2187 |
+
"OTHER",
|
| 2188 |
+
"JAVA_OBJECT",
|
| 2189 |
+
"DISTINCT",
|
| 2190 |
+
"STRUCT",
|
| 2191 |
+
"ARRAY",
|
| 2192 |
+
"CLOB",
|
| 2193 |
+
"REF",
|
| 2194 |
+
"DATALINK",
|
| 2195 |
+
"ROWID",
|
| 2196 |
+
"BINARY",
|
| 2197 |
+
"VARBINARY",
|
| 2198 |
+
"LONGVARBINARY",
|
| 2199 |
+
"NCLOB",
|
| 2200 |
+
"SQLXML",
|
| 2201 |
+
"REF_CURSOR",
|
| 2202 |
+
"TIME_WITH_TIMEZONE",
|
| 2203 |
+
"TIMESTAMP_WITH_TIMEZONE"
|
| 2204 |
+
],
|
| 2205 |
+
"enumDeprecated": [
|
| 2206 |
+
false,
|
| 2207 |
+
true,
|
| 2208 |
+
false,
|
| 2209 |
+
false,
|
| 2210 |
+
false,
|
| 2211 |
+
true,
|
| 2212 |
+
false,
|
| 2213 |
+
true,
|
| 2214 |
+
true,
|
| 2215 |
+
false,
|
| 2216 |
+
false,
|
| 2217 |
+
true,
|
| 2218 |
+
false,
|
| 2219 |
+
false,
|
| 2220 |
+
false,
|
| 2221 |
+
false,
|
| 2222 |
+
false,
|
| 2223 |
+
false,
|
| 2224 |
+
false,
|
| 2225 |
+
false,
|
| 2226 |
+
false,
|
| 2227 |
+
false,
|
| 2228 |
+
false,
|
| 2229 |
+
false,
|
| 2230 |
+
false,
|
| 2231 |
+
false,
|
| 2232 |
+
false,
|
| 2233 |
+
false,
|
| 2234 |
+
false,
|
| 2235 |
+
false,
|
| 2236 |
+
false,
|
| 2237 |
+
false,
|
| 2238 |
+
false,
|
| 2239 |
+
false,
|
| 2240 |
+
false,
|
| 2241 |
+
false,
|
| 2242 |
+
false,
|
| 2243 |
+
false,
|
| 2244 |
+
false,
|
| 2245 |
+
false,
|
| 2246 |
+
false,
|
| 2247 |
+
false,
|
| 2248 |
+
false,
|
| 2249 |
+
false,
|
| 2250 |
+
false
|
| 2251 |
+
],
|
| 2252 |
+
"enumDescriptions": [
|
| 2253 |
+
"Datatype unspecified.",
|
| 2254 |
+
"Deprecated Int type, use INTEGER type instead.",
|
| 2255 |
+
"Small int type.",
|
| 2256 |
+
"Double type.",
|
| 2257 |
+
"Date type.",
|
| 2258 |
+
"Deprecated Datetime type.",
|
| 2259 |
+
"Time type.",
|
| 2260 |
+
"Deprecated string type, use VARCHAR type instead.",
|
| 2261 |
+
"Deprecated Long type, use BIGINT type instead.",
|
| 2262 |
+
"Boolean type.",
|
| 2263 |
+
"Decimal type.",
|
| 2264 |
+
"Deprecated UUID type, use VARCHAR instead.",
|
| 2265 |
+
"Blob type.",
|
| 2266 |
+
"Bit type.",
|
| 2267 |
+
"Tiny int type.",
|
| 2268 |
+
"Integer type.",
|
| 2269 |
+
"Big int type.",
|
| 2270 |
+
"Float type.",
|
| 2271 |
+
"Real type.",
|
| 2272 |
+
"Numeric type.",
|
| 2273 |
+
"Char type.",
|
| 2274 |
+
"Varchar type.",
|
| 2275 |
+
"Long varchar type.",
|
| 2276 |
+
"Timestamp type.",
|
| 2277 |
+
"Nchar type.",
|
| 2278 |
+
"Nvarchar type.",
|
| 2279 |
+
"Long Nvarchar type.",
|
| 2280 |
+
"Null type.",
|
| 2281 |
+
"Other type.",
|
| 2282 |
+
"Java object type.",
|
| 2283 |
+
"Distinct type keyword.",
|
| 2284 |
+
"Struct type.",
|
| 2285 |
+
"Array type.",
|
| 2286 |
+
"Clob type.",
|
| 2287 |
+
"Ref type.",
|
| 2288 |
+
"Datalink type.",
|
| 2289 |
+
"Row ID type.",
|
| 2290 |
+
"Binary type.",
|
| 2291 |
+
"Varbinary type.",
|
| 2292 |
+
"Long Varbinary type.",
|
| 2293 |
+
"Nclob type.",
|
| 2294 |
+
"SQLXML type.",
|
| 2295 |
+
"Ref_cursor type.",
|
| 2296 |
+
"Time with timezone type.",
|
| 2297 |
+
"Timestamp with timezone type."
|
| 2298 |
+
],
|
| 2299 |
+
"type": "string"
|
| 2300 |
+
},
|
| 2301 |
+
"defaultValue": {
|
| 2302 |
+
"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.",
|
| 2303 |
+
"type": "any"
|
| 2304 |
+
},
|
| 2305 |
+
"description": {
|
| 2306 |
+
"description": "A brief description of the metadata field.",
|
| 2307 |
+
"type": "string"
|
| 2308 |
+
},
|
| 2309 |
+
"jsonSchema": {
|
| 2310 |
+
"$ref": "JsonSchema",
|
| 2311 |
+
"description": "JsonSchema of the result, applicable only if parameter is of type `STRUCT`"
|
| 2312 |
+
},
|
| 2313 |
+
"name": {
|
| 2314 |
+
"description": "Name of the metadata field.",
|
| 2315 |
+
"type": "string"
|
| 2316 |
+
},
|
| 2317 |
+
"nullable": {
|
| 2318 |
+
"description": "Specifies whether a null value is allowed.",
|
| 2319 |
+
"type": "boolean"
|
| 2320 |
+
}
|
| 2321 |
+
},
|
| 2322 |
+
"type": "object"
|
| 2323 |
+
},
|
| 2324 |
+
"Schedule": {
|
| 2325 |
+
"description": "Configure the schedule.",
|
| 2326 |
+
"id": "Schedule",
|
| 2327 |
+
"properties": {
|
| 2328 |
+
"day": {
|
| 2329 |
+
"description": "Allows to define schedule that runs specified day of the week.",
|
| 2330 |
+
"enum": [
|
| 2331 |
+
"DAY_OF_WEEK_UNSPECIFIED",
|
| 2332 |
+
"MONDAY",
|
| 2333 |
+
"TUESDAY",
|
| 2334 |
+
"WEDNESDAY",
|
| 2335 |
+
"THURSDAY",
|
| 2336 |
+
"FRIDAY",
|
| 2337 |
+
"SATURDAY",
|
| 2338 |
+
"SUNDAY"
|
| 2339 |
+
],
|
| 2340 |
+
"enumDescriptions": [
|
| 2341 |
+
"The day of the week is unspecified.",
|
| 2342 |
+
"Monday",
|
| 2343 |
+
"Tuesday",
|
| 2344 |
+
"Wednesday",
|
| 2345 |
+
"Thursday",
|
| 2346 |
+
"Friday",
|
| 2347 |
+
"Saturday",
|
| 2348 |
+
"Sunday"
|
| 2349 |
+
],
|
| 2350 |
+
"type": "string"
|
| 2351 |
+
},
|
| 2352 |
+
"duration": {
|
| 2353 |
+
"description": "Output only. Duration of the time window, set by service producer.",
|
| 2354 |
+
"format": "google-duration",
|
| 2355 |
+
"type": "string"
|
| 2356 |
+
},
|
| 2357 |
+
"startTime": {
|
| 2358 |
+
"$ref": "TimeOfDay",
|
| 2359 |
+
"description": "Time within the window to start the operations."
|
| 2360 |
+
}
|
| 2361 |
+
},
|
| 2362 |
+
"type": "object"
|
| 2363 |
+
},
|
| 2364 |
+
"SloEligibility": {
|
| 2365 |
+
"description": "SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.",
|
| 2366 |
+
"id": "SloEligibility",
|
| 2367 |
+
"properties": {
|
| 2368 |
+
"eligible": {
|
| 2369 |
+
"description": "Whether an instance is eligible or ineligible.",
|
| 2370 |
+
"type": "boolean"
|
| 2371 |
+
},
|
| 2372 |
+
"reason": {
|
| 2373 |
+
"description": "User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.",
|
| 2374 |
+
"type": "string"
|
| 2375 |
+
}
|
| 2376 |
+
},
|
| 2377 |
+
"type": "object"
|
| 2378 |
+
},
|
| 2379 |
+
"SloMetadata": {
|
| 2380 |
+
"description": "SloMetadata contains resources required for proper SLO classification of the instance.",
|
| 2381 |
+
"id": "SloMetadata",
|
| 2382 |
+
"properties": {
|
| 2383 |
+
"nodes": {
|
| 2384 |
+
"description": "Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.",
|
| 2385 |
+
"items": {
|
| 2386 |
+
"$ref": "NodeSloMetadata"
|
| 2387 |
+
},
|
| 2388 |
+
"type": "array"
|
| 2389 |
+
},
|
| 2390 |
+
"perSliEligibility": {
|
| 2391 |
+
"$ref": "PerSliSloEligibility",
|
| 2392 |
+
"description": "Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs."
|
| 2393 |
+
},
|
| 2394 |
+
"tier": {
|
| 2395 |
+
"description": "Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty.",
|
| 2396 |
+
"type": "string"
|
| 2397 |
+
}
|
| 2398 |
+
},
|
| 2399 |
+
"type": "object"
|
| 2400 |
+
},
|
| 2401 |
+
"TimeOfDay": {
|
| 2402 |
+
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
|
| 2403 |
+
"id": "TimeOfDay",
|
| 2404 |
+
"properties": {
|
| 2405 |
+
"hours": {
|
| 2406 |
+
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
|
| 2407 |
+
"format": "int32",
|
| 2408 |
+
"type": "integer"
|
| 2409 |
+
},
|
| 2410 |
+
"minutes": {
|
| 2411 |
+
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
|
| 2412 |
+
"format": "int32",
|
| 2413 |
+
"type": "integer"
|
| 2414 |
+
},
|
| 2415 |
+
"nanos": {
|
| 2416 |
+
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
|
| 2417 |
+
"format": "int32",
|
| 2418 |
+
"type": "integer"
|
| 2419 |
+
},
|
| 2420 |
+
"seconds": {
|
| 2421 |
+
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
|
| 2422 |
+
"format": "int32",
|
| 2423 |
+
"type": "integer"
|
| 2424 |
+
}
|
| 2425 |
+
},
|
| 2426 |
+
"type": "object"
|
| 2427 |
+
},
|
| 2428 |
+
"UpdateEntitiesWithConditionsResponse": {
|
| 2429 |
+
"description": "Response message for EntityService.UpdateEntitiesWithConditions",
|
| 2430 |
+
"id": "UpdateEntitiesWithConditionsResponse",
|
| 2431 |
+
"properties": {
|
| 2432 |
+
"response": {
|
| 2433 |
+
"additionalProperties": {
|
| 2434 |
+
"description": "Properties of the object.",
|
| 2435 |
+
"type": "any"
|
| 2436 |
+
},
|
| 2437 |
+
"description": "Response returned by the external system.",
|
| 2438 |
+
"type": "object"
|
| 2439 |
+
}
|
| 2440 |
+
},
|
| 2441 |
+
"type": "object"
|
| 2442 |
+
},
|
| 2443 |
+
"UpdatePolicy": {
|
| 2444 |
+
"description": "Maintenance policy applicable to instance updates.",
|
| 2445 |
+
"id": "UpdatePolicy",
|
| 2446 |
+
"properties": {
|
| 2447 |
+
"channel": {
|
| 2448 |
+
"description": "Optional. Relative scheduling channel applied to resource.",
|
| 2449 |
+
"enum": [
|
| 2450 |
+
"UPDATE_CHANNEL_UNSPECIFIED",
|
| 2451 |
+
"EARLIER",
|
| 2452 |
+
"LATER",
|
| 2453 |
+
"WEEK1",
|
| 2454 |
+
"WEEK2",
|
| 2455 |
+
"WEEK5"
|
| 2456 |
+
],
|
| 2457 |
+
"enumDescriptions": [
|
| 2458 |
+
"Unspecified channel.",
|
| 2459 |
+
"Early channel within a customer project.",
|
| 2460 |
+
"Later channel within a customer project.",
|
| 2461 |
+
"! ! The follow channels can ONLY be used if you adopt the new MW system! ! ! NOTE: all WEEK channels are assumed to be under a weekly window. ! There is currently no dedicated channel definitions for Daily windows. ! If you use Daily window, the system will assume a 1d (24Hours) advanced ! notification period b/w EARLY and LATER. ! We may consider support more flexible daily channel specifications in ! the future. WEEK1 == EARLIER with minimum 7d advanced notification. {7d, 14d} The system will treat them equally and will use WEEK1 whenever it can. New customers are encouraged to use this channel annotation.",
|
| 2462 |
+
"WEEK2 == LATER with minimum 14d advanced notification {14d, 21d}.",
|
| 2463 |
+
"WEEK5 == 40d support. minimum 35d advanced notification {35d, 42d}."
|
| 2464 |
+
],
|
| 2465 |
+
"type": "string"
|
| 2466 |
+
},
|
| 2467 |
+
"denyMaintenancePeriods": {
|
| 2468 |
+
"description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. The protocol supports zero-to-many such periods, but the current SLM Rollout implementation only supports zero-to-one.",
|
| 2469 |
+
"items": {
|
| 2470 |
+
"$ref": "DenyMaintenancePeriod"
|
| 2471 |
+
},
|
| 2472 |
+
"type": "array"
|
| 2473 |
+
},
|
| 2474 |
+
"window": {
|
| 2475 |
+
"$ref": "MaintenanceWindow",
|
| 2476 |
+
"description": "Optional. Maintenance window that is applied to resources covered by this policy."
|
| 2477 |
+
}
|
| 2478 |
+
},
|
| 2479 |
+
"type": "object"
|
| 2480 |
+
},
|
| 2481 |
+
"WeeklyCycle": {
|
| 2482 |
+
"description": "Time window specified for weekly operations.",
|
| 2483 |
+
"id": "WeeklyCycle",
|
| 2484 |
+
"properties": {
|
| 2485 |
+
"schedule": {
|
| 2486 |
+
"description": "User can specify multiple windows in a week. Minimum of 1 window.",
|
| 2487 |
+
"items": {
|
| 2488 |
+
"$ref": "Schedule"
|
| 2489 |
+
},
|
| 2490 |
+
"type": "array"
|
| 2491 |
+
}
|
| 2492 |
+
},
|
| 2493 |
+
"type": "object"
|
| 2494 |
+
}
|
| 2495 |
+
},
|
| 2496 |
+
"servicePath": "",
|
| 2497 |
+
"title": "Connectors API",
|
| 2498 |
+
"version": "v2",
|
| 2499 |
+
"version_module": true
|
| 2500 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/css.v1.json
ADDED
|
@@ -0,0 +1,1310 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/content": {
|
| 6 |
+
"description": "Manage your product listings and accounts for Google Shopping"
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://css.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Css",
|
| 15 |
+
"description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "css:v1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://css.mtls.googleapis.com/",
|
| 26 |
+
"name": "css",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"accounts": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"get": {
|
| 111 |
+
"description": "Retrieves a single CSS/MC account by ID.",
|
| 112 |
+
"flatPath": "v1/accounts/{accountsId}",
|
| 113 |
+
"httpMethod": "GET",
|
| 114 |
+
"id": "css.accounts.get",
|
| 115 |
+
"parameterOrder": [
|
| 116 |
+
"name"
|
| 117 |
+
],
|
| 118 |
+
"parameters": {
|
| 119 |
+
"name": {
|
| 120 |
+
"description": "Required. The name of the managed CSS/MC account. Format: accounts/{account}",
|
| 121 |
+
"location": "path",
|
| 122 |
+
"pattern": "^accounts/[^/]+$",
|
| 123 |
+
"required": true,
|
| 124 |
+
"type": "string"
|
| 125 |
+
},
|
| 126 |
+
"parent": {
|
| 127 |
+
"description": "Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}",
|
| 128 |
+
"location": "query",
|
| 129 |
+
"type": "string"
|
| 130 |
+
}
|
| 131 |
+
},
|
| 132 |
+
"path": "v1/{+name}",
|
| 133 |
+
"response": {
|
| 134 |
+
"$ref": "Account"
|
| 135 |
+
},
|
| 136 |
+
"scopes": [
|
| 137 |
+
"https://www.googleapis.com/auth/content"
|
| 138 |
+
]
|
| 139 |
+
},
|
| 140 |
+
"listChildAccounts": {
|
| 141 |
+
"description": "Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.",
|
| 142 |
+
"flatPath": "v1/accounts/{accountsId}:listChildAccounts",
|
| 143 |
+
"httpMethod": "GET",
|
| 144 |
+
"id": "css.accounts.listChildAccounts",
|
| 145 |
+
"parameterOrder": [
|
| 146 |
+
"parent"
|
| 147 |
+
],
|
| 148 |
+
"parameters": {
|
| 149 |
+
"fullName": {
|
| 150 |
+
"description": "If set, only the MC accounts with the given name (case sensitive) will be returned.",
|
| 151 |
+
"location": "query",
|
| 152 |
+
"type": "string"
|
| 153 |
+
},
|
| 154 |
+
"labelId": {
|
| 155 |
+
"description": "If set, only the MC accounts with the given label ID will be returned.",
|
| 156 |
+
"format": "int64",
|
| 157 |
+
"location": "query",
|
| 158 |
+
"type": "string"
|
| 159 |
+
},
|
| 160 |
+
"pageSize": {
|
| 161 |
+
"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
|
| 162 |
+
"format": "int32",
|
| 163 |
+
"location": "query",
|
| 164 |
+
"type": "integer"
|
| 165 |
+
},
|
| 166 |
+
"pageToken": {
|
| 167 |
+
"description": "Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.",
|
| 168 |
+
"location": "query",
|
| 169 |
+
"type": "string"
|
| 170 |
+
},
|
| 171 |
+
"parent": {
|
| 172 |
+
"description": "Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}",
|
| 173 |
+
"location": "path",
|
| 174 |
+
"pattern": "^accounts/[^/]+$",
|
| 175 |
+
"required": true,
|
| 176 |
+
"type": "string"
|
| 177 |
+
}
|
| 178 |
+
},
|
| 179 |
+
"path": "v1/{+parent}:listChildAccounts",
|
| 180 |
+
"response": {
|
| 181 |
+
"$ref": "ListChildAccountsResponse"
|
| 182 |
+
},
|
| 183 |
+
"scopes": [
|
| 184 |
+
"https://www.googleapis.com/auth/content"
|
| 185 |
+
]
|
| 186 |
+
},
|
| 187 |
+
"updateLabels": {
|
| 188 |
+
"description": "Updates labels assigned to CSS/MC accounts by a CSS domain.",
|
| 189 |
+
"flatPath": "v1/accounts/{accountsId}:updateLabels",
|
| 190 |
+
"httpMethod": "POST",
|
| 191 |
+
"id": "css.accounts.updateLabels",
|
| 192 |
+
"parameterOrder": [
|
| 193 |
+
"name"
|
| 194 |
+
],
|
| 195 |
+
"parameters": {
|
| 196 |
+
"name": {
|
| 197 |
+
"description": "Required. The label resource name. Format: accounts/{account}",
|
| 198 |
+
"location": "path",
|
| 199 |
+
"pattern": "^accounts/[^/]+$",
|
| 200 |
+
"required": true,
|
| 201 |
+
"type": "string"
|
| 202 |
+
}
|
| 203 |
+
},
|
| 204 |
+
"path": "v1/{+name}:updateLabels",
|
| 205 |
+
"request": {
|
| 206 |
+
"$ref": "UpdateAccountLabelsRequest"
|
| 207 |
+
},
|
| 208 |
+
"response": {
|
| 209 |
+
"$ref": "Account"
|
| 210 |
+
},
|
| 211 |
+
"scopes": [
|
| 212 |
+
"https://www.googleapis.com/auth/content"
|
| 213 |
+
]
|
| 214 |
+
}
|
| 215 |
+
},
|
| 216 |
+
"resources": {
|
| 217 |
+
"cssProductInputs": {
|
| 218 |
+
"methods": {
|
| 219 |
+
"delete": {
|
| 220 |
+
"description": "Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.",
|
| 221 |
+
"flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}",
|
| 222 |
+
"httpMethod": "DELETE",
|
| 223 |
+
"id": "css.accounts.cssProductInputs.delete",
|
| 224 |
+
"parameterOrder": [
|
| 225 |
+
"name"
|
| 226 |
+
],
|
| 227 |
+
"parameters": {
|
| 228 |
+
"name": {
|
| 229 |
+
"description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}",
|
| 230 |
+
"location": "path",
|
| 231 |
+
"pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$",
|
| 232 |
+
"required": true,
|
| 233 |
+
"type": "string"
|
| 234 |
+
},
|
| 235 |
+
"supplementalFeedId": {
|
| 236 |
+
"description": "The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.",
|
| 237 |
+
"format": "int64",
|
| 238 |
+
"location": "query",
|
| 239 |
+
"type": "string"
|
| 240 |
+
}
|
| 241 |
+
},
|
| 242 |
+
"path": "v1/{+name}",
|
| 243 |
+
"response": {
|
| 244 |
+
"$ref": "Empty"
|
| 245 |
+
},
|
| 246 |
+
"scopes": [
|
| 247 |
+
"https://www.googleapis.com/auth/content"
|
| 248 |
+
]
|
| 249 |
+
},
|
| 250 |
+
"insert": {
|
| 251 |
+
"description": "Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.",
|
| 252 |
+
"flatPath": "v1/accounts/{accountsId}/cssProductInputs:insert",
|
| 253 |
+
"httpMethod": "POST",
|
| 254 |
+
"id": "css.accounts.cssProductInputs.insert",
|
| 255 |
+
"parameterOrder": [
|
| 256 |
+
"parent"
|
| 257 |
+
],
|
| 258 |
+
"parameters": {
|
| 259 |
+
"feedId": {
|
| 260 |
+
"deprecated": true,
|
| 261 |
+
"description": "Optional. DEPRECATED. Feed id is not required for CSS Products. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.",
|
| 262 |
+
"format": "int64",
|
| 263 |
+
"location": "query",
|
| 264 |
+
"type": "string"
|
| 265 |
+
},
|
| 266 |
+
"parent": {
|
| 267 |
+
"description": "Required. The account where this CSS Product will be inserted. Format: accounts/{account}",
|
| 268 |
+
"location": "path",
|
| 269 |
+
"pattern": "^accounts/[^/]+$",
|
| 270 |
+
"required": true,
|
| 271 |
+
"type": "string"
|
| 272 |
+
}
|
| 273 |
+
},
|
| 274 |
+
"path": "v1/{+parent}/cssProductInputs:insert",
|
| 275 |
+
"request": {
|
| 276 |
+
"$ref": "CssProductInput"
|
| 277 |
+
},
|
| 278 |
+
"response": {
|
| 279 |
+
"$ref": "CssProductInput"
|
| 280 |
+
},
|
| 281 |
+
"scopes": [
|
| 282 |
+
"https://www.googleapis.com/auth/content"
|
| 283 |
+
]
|
| 284 |
+
},
|
| 285 |
+
"patch": {
|
| 286 |
+
"description": "Updates the existing Css Product input in your CSS Center account. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed Css Product can be retrieved.",
|
| 287 |
+
"flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}",
|
| 288 |
+
"httpMethod": "PATCH",
|
| 289 |
+
"id": "css.accounts.cssProductInputs.patch",
|
| 290 |
+
"parameterOrder": [
|
| 291 |
+
"name"
|
| 292 |
+
],
|
| 293 |
+
"parameters": {
|
| 294 |
+
"name": {
|
| 295 |
+
"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`",
|
| 296 |
+
"location": "path",
|
| 297 |
+
"pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$",
|
| 298 |
+
"required": true,
|
| 299 |
+
"type": "string"
|
| 300 |
+
},
|
| 301 |
+
"updateMask": {
|
| 302 |
+
"description": "The list of CSS product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the CSS product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the `custom_attribute.` prefix. Providing special \"*\" value for full CSS product replacement is not supported.",
|
| 303 |
+
"format": "google-fieldmask",
|
| 304 |
+
"location": "query",
|
| 305 |
+
"type": "string"
|
| 306 |
+
}
|
| 307 |
+
},
|
| 308 |
+
"path": "v1/{+name}",
|
| 309 |
+
"request": {
|
| 310 |
+
"$ref": "CssProductInput"
|
| 311 |
+
},
|
| 312 |
+
"response": {
|
| 313 |
+
"$ref": "CssProductInput"
|
| 314 |
+
},
|
| 315 |
+
"scopes": [
|
| 316 |
+
"https://www.googleapis.com/auth/content"
|
| 317 |
+
]
|
| 318 |
+
}
|
| 319 |
+
}
|
| 320 |
+
},
|
| 321 |
+
"cssProducts": {
|
| 322 |
+
"methods": {
|
| 323 |
+
"get": {
|
| 324 |
+
"description": "Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.",
|
| 325 |
+
"flatPath": "v1/accounts/{accountsId}/cssProducts/{cssProductsId}",
|
| 326 |
+
"httpMethod": "GET",
|
| 327 |
+
"id": "css.accounts.cssProducts.get",
|
| 328 |
+
"parameterOrder": [
|
| 329 |
+
"name"
|
| 330 |
+
],
|
| 331 |
+
"parameters": {
|
| 332 |
+
"name": {
|
| 333 |
+
"description": "Required. The name of the CSS product to retrieve.",
|
| 334 |
+
"location": "path",
|
| 335 |
+
"pattern": "^accounts/[^/]+/cssProducts/[^/]+$",
|
| 336 |
+
"required": true,
|
| 337 |
+
"type": "string"
|
| 338 |
+
}
|
| 339 |
+
},
|
| 340 |
+
"path": "v1/{+name}",
|
| 341 |
+
"response": {
|
| 342 |
+
"$ref": "CssProduct"
|
| 343 |
+
},
|
| 344 |
+
"scopes": [
|
| 345 |
+
"https://www.googleapis.com/auth/content"
|
| 346 |
+
]
|
| 347 |
+
},
|
| 348 |
+
"list": {
|
| 349 |
+
"description": "Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.",
|
| 350 |
+
"flatPath": "v1/accounts/{accountsId}/cssProducts",
|
| 351 |
+
"httpMethod": "GET",
|
| 352 |
+
"id": "css.accounts.cssProducts.list",
|
| 353 |
+
"parameterOrder": [
|
| 354 |
+
"parent"
|
| 355 |
+
],
|
| 356 |
+
"parameters": {
|
| 357 |
+
"pageSize": {
|
| 358 |
+
"description": "The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.",
|
| 359 |
+
"format": "int32",
|
| 360 |
+
"location": "query",
|
| 361 |
+
"type": "integer"
|
| 362 |
+
},
|
| 363 |
+
"pageToken": {
|
| 364 |
+
"description": "A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.",
|
| 365 |
+
"location": "query",
|
| 366 |
+
"type": "string"
|
| 367 |
+
},
|
| 368 |
+
"parent": {
|
| 369 |
+
"description": "Required. The account/domain to list processed CSS Products for. Format: accounts/{account}",
|
| 370 |
+
"location": "path",
|
| 371 |
+
"pattern": "^accounts/[^/]+$",
|
| 372 |
+
"required": true,
|
| 373 |
+
"type": "string"
|
| 374 |
+
}
|
| 375 |
+
},
|
| 376 |
+
"path": "v1/{+parent}/cssProducts",
|
| 377 |
+
"response": {
|
| 378 |
+
"$ref": "ListCssProductsResponse"
|
| 379 |
+
},
|
| 380 |
+
"scopes": [
|
| 381 |
+
"https://www.googleapis.com/auth/content"
|
| 382 |
+
]
|
| 383 |
+
}
|
| 384 |
+
}
|
| 385 |
+
},
|
| 386 |
+
"labels": {
|
| 387 |
+
"methods": {
|
| 388 |
+
"create": {
|
| 389 |
+
"description": "Creates a new label, not assigned to any account.",
|
| 390 |
+
"flatPath": "v1/accounts/{accountsId}/labels",
|
| 391 |
+
"httpMethod": "POST",
|
| 392 |
+
"id": "css.accounts.labels.create",
|
| 393 |
+
"parameterOrder": [
|
| 394 |
+
"parent"
|
| 395 |
+
],
|
| 396 |
+
"parameters": {
|
| 397 |
+
"parent": {
|
| 398 |
+
"description": "Required. The parent account. Format: accounts/{account}",
|
| 399 |
+
"location": "path",
|
| 400 |
+
"pattern": "^accounts/[^/]+$",
|
| 401 |
+
"required": true,
|
| 402 |
+
"type": "string"
|
| 403 |
+
}
|
| 404 |
+
},
|
| 405 |
+
"path": "v1/{+parent}/labels",
|
| 406 |
+
"request": {
|
| 407 |
+
"$ref": "AccountLabel"
|
| 408 |
+
},
|
| 409 |
+
"response": {
|
| 410 |
+
"$ref": "AccountLabel"
|
| 411 |
+
},
|
| 412 |
+
"scopes": [
|
| 413 |
+
"https://www.googleapis.com/auth/content"
|
| 414 |
+
]
|
| 415 |
+
},
|
| 416 |
+
"delete": {
|
| 417 |
+
"description": "Deletes a label and removes it from all accounts to which it was assigned.",
|
| 418 |
+
"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}",
|
| 419 |
+
"httpMethod": "DELETE",
|
| 420 |
+
"id": "css.accounts.labels.delete",
|
| 421 |
+
"parameterOrder": [
|
| 422 |
+
"name"
|
| 423 |
+
],
|
| 424 |
+
"parameters": {
|
| 425 |
+
"name": {
|
| 426 |
+
"description": "Required. The name of the label to delete. Format: accounts/{account}/labels/{label}",
|
| 427 |
+
"location": "path",
|
| 428 |
+
"pattern": "^accounts/[^/]+/labels/[^/]+$",
|
| 429 |
+
"required": true,
|
| 430 |
+
"type": "string"
|
| 431 |
+
}
|
| 432 |
+
},
|
| 433 |
+
"path": "v1/{+name}",
|
| 434 |
+
"response": {
|
| 435 |
+
"$ref": "Empty"
|
| 436 |
+
},
|
| 437 |
+
"scopes": [
|
| 438 |
+
"https://www.googleapis.com/auth/content"
|
| 439 |
+
]
|
| 440 |
+
},
|
| 441 |
+
"list": {
|
| 442 |
+
"description": "Lists the labels owned by an account.",
|
| 443 |
+
"flatPath": "v1/accounts/{accountsId}/labels",
|
| 444 |
+
"httpMethod": "GET",
|
| 445 |
+
"id": "css.accounts.labels.list",
|
| 446 |
+
"parameterOrder": [
|
| 447 |
+
"parent"
|
| 448 |
+
],
|
| 449 |
+
"parameters": {
|
| 450 |
+
"pageSize": {
|
| 451 |
+
"description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
|
| 452 |
+
"format": "int32",
|
| 453 |
+
"location": "query",
|
| 454 |
+
"type": "integer"
|
| 455 |
+
},
|
| 456 |
+
"pageToken": {
|
| 457 |
+
"description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.",
|
| 458 |
+
"location": "query",
|
| 459 |
+
"type": "string"
|
| 460 |
+
},
|
| 461 |
+
"parent": {
|
| 462 |
+
"description": "Required. The parent account. Format: accounts/{account}",
|
| 463 |
+
"location": "path",
|
| 464 |
+
"pattern": "^accounts/[^/]+$",
|
| 465 |
+
"required": true,
|
| 466 |
+
"type": "string"
|
| 467 |
+
}
|
| 468 |
+
},
|
| 469 |
+
"path": "v1/{+parent}/labels",
|
| 470 |
+
"response": {
|
| 471 |
+
"$ref": "ListAccountLabelsResponse"
|
| 472 |
+
},
|
| 473 |
+
"scopes": [
|
| 474 |
+
"https://www.googleapis.com/auth/content"
|
| 475 |
+
]
|
| 476 |
+
},
|
| 477 |
+
"patch": {
|
| 478 |
+
"description": "Updates a label.",
|
| 479 |
+
"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}",
|
| 480 |
+
"httpMethod": "PATCH",
|
| 481 |
+
"id": "css.accounts.labels.patch",
|
| 482 |
+
"parameterOrder": [
|
| 483 |
+
"name"
|
| 484 |
+
],
|
| 485 |
+
"parameters": {
|
| 486 |
+
"name": {
|
| 487 |
+
"description": "The resource name of the label. Format: accounts/{account}/labels/{label}",
|
| 488 |
+
"location": "path",
|
| 489 |
+
"pattern": "^accounts/[^/]+/labels/[^/]+$",
|
| 490 |
+
"required": true,
|
| 491 |
+
"type": "string"
|
| 492 |
+
}
|
| 493 |
+
},
|
| 494 |
+
"path": "v1/{+name}",
|
| 495 |
+
"request": {
|
| 496 |
+
"$ref": "AccountLabel"
|
| 497 |
+
},
|
| 498 |
+
"response": {
|
| 499 |
+
"$ref": "AccountLabel"
|
| 500 |
+
},
|
| 501 |
+
"scopes": [
|
| 502 |
+
"https://www.googleapis.com/auth/content"
|
| 503 |
+
]
|
| 504 |
+
}
|
| 505 |
+
}
|
| 506 |
+
}
|
| 507 |
+
}
|
| 508 |
+
}
|
| 509 |
+
},
|
| 510 |
+
"revision": "20250106",
|
| 511 |
+
"rootUrl": "https://css.googleapis.com/",
|
| 512 |
+
"schemas": {
|
| 513 |
+
"Account": {
|
| 514 |
+
"description": "Information about CSS/MC account.",
|
| 515 |
+
"id": "Account",
|
| 516 |
+
"properties": {
|
| 517 |
+
"accountType": {
|
| 518 |
+
"description": "Output only. The type of this account.",
|
| 519 |
+
"enum": [
|
| 520 |
+
"ACCOUNT_TYPE_UNSPECIFIED",
|
| 521 |
+
"CSS_GROUP",
|
| 522 |
+
"CSS_DOMAIN",
|
| 523 |
+
"MC_PRIMARY_CSS_MCA",
|
| 524 |
+
"MC_CSS_MCA",
|
| 525 |
+
"MC_MARKETPLACE_MCA",
|
| 526 |
+
"MC_OTHER_MCA",
|
| 527 |
+
"MC_STANDALONE",
|
| 528 |
+
"MC_MCA_SUBACCOUNT"
|
| 529 |
+
],
|
| 530 |
+
"enumDescriptions": [
|
| 531 |
+
"Unknown account type.",
|
| 532 |
+
"CSS group account.",
|
| 533 |
+
"CSS domain account.",
|
| 534 |
+
"MC Primary CSS MCA account.",
|
| 535 |
+
"MC CSS MCA account.",
|
| 536 |
+
"MC Marketplace MCA account.",
|
| 537 |
+
"MC Other MCA account.",
|
| 538 |
+
"MC Standalone account.",
|
| 539 |
+
"MC MCA sub-account."
|
| 540 |
+
],
|
| 541 |
+
"readOnly": true,
|
| 542 |
+
"type": "string"
|
| 543 |
+
},
|
| 544 |
+
"automaticLabelIds": {
|
| 545 |
+
"description": "Automatically created label IDs assigned to the MC account by CSS Center.",
|
| 546 |
+
"items": {
|
| 547 |
+
"format": "int64",
|
| 548 |
+
"type": "string"
|
| 549 |
+
},
|
| 550 |
+
"type": "array"
|
| 551 |
+
},
|
| 552 |
+
"displayName": {
|
| 553 |
+
"description": "The CSS/MC account's short display name.",
|
| 554 |
+
"type": "string"
|
| 555 |
+
},
|
| 556 |
+
"fullName": {
|
| 557 |
+
"description": "Output only. Immutable. The CSS/MC account's full name.",
|
| 558 |
+
"readOnly": true,
|
| 559 |
+
"type": "string"
|
| 560 |
+
},
|
| 561 |
+
"homepageUri": {
|
| 562 |
+
"description": "Output only. Immutable. The CSS/MC account's homepage.",
|
| 563 |
+
"readOnly": true,
|
| 564 |
+
"type": "string"
|
| 565 |
+
},
|
| 566 |
+
"labelIds": {
|
| 567 |
+
"description": "Manually created label IDs assigned to the CSS/MC account by a CSS parent account.",
|
| 568 |
+
"items": {
|
| 569 |
+
"format": "int64",
|
| 570 |
+
"type": "string"
|
| 571 |
+
},
|
| 572 |
+
"type": "array"
|
| 573 |
+
},
|
| 574 |
+
"name": {
|
| 575 |
+
"description": "The label resource name. Format: accounts/{account}",
|
| 576 |
+
"type": "string"
|
| 577 |
+
},
|
| 578 |
+
"parent": {
|
| 579 |
+
"description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.",
|
| 580 |
+
"type": "string"
|
| 581 |
+
}
|
| 582 |
+
},
|
| 583 |
+
"type": "object"
|
| 584 |
+
},
|
| 585 |
+
"AccountLabel": {
|
| 586 |
+
"description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
|
| 587 |
+
"id": "AccountLabel",
|
| 588 |
+
"properties": {
|
| 589 |
+
"accountId": {
|
| 590 |
+
"description": "Output only. The ID of account this label belongs to.",
|
| 591 |
+
"format": "int64",
|
| 592 |
+
"readOnly": true,
|
| 593 |
+
"type": "string"
|
| 594 |
+
},
|
| 595 |
+
"description": {
|
| 596 |
+
"description": "The description of this label.",
|
| 597 |
+
"type": "string"
|
| 598 |
+
},
|
| 599 |
+
"displayName": {
|
| 600 |
+
"description": "The display name of this label.",
|
| 601 |
+
"type": "string"
|
| 602 |
+
},
|
| 603 |
+
"labelId": {
|
| 604 |
+
"description": "Output only. The ID of the label.",
|
| 605 |
+
"format": "int64",
|
| 606 |
+
"readOnly": true,
|
| 607 |
+
"type": "string"
|
| 608 |
+
},
|
| 609 |
+
"labelType": {
|
| 610 |
+
"description": "Output only. The type of this label.",
|
| 611 |
+
"enum": [
|
| 612 |
+
"LABEL_TYPE_UNSPECIFIED",
|
| 613 |
+
"MANUAL",
|
| 614 |
+
"AUTOMATIC"
|
| 615 |
+
],
|
| 616 |
+
"enumDescriptions": [
|
| 617 |
+
"Unknown label type.",
|
| 618 |
+
"Indicates that the label was created manually.",
|
| 619 |
+
"Indicates that the label was created automatically by CSS Center."
|
| 620 |
+
],
|
| 621 |
+
"readOnly": true,
|
| 622 |
+
"type": "string"
|
| 623 |
+
},
|
| 624 |
+
"name": {
|
| 625 |
+
"description": "The resource name of the label. Format: accounts/{account}/labels/{label}",
|
| 626 |
+
"type": "string"
|
| 627 |
+
}
|
| 628 |
+
},
|
| 629 |
+
"type": "object"
|
| 630 |
+
},
|
| 631 |
+
"Attributes": {
|
| 632 |
+
"description": "Attributes for CSS Product.",
|
| 633 |
+
"id": "Attributes",
|
| 634 |
+
"properties": {
|
| 635 |
+
"additionalImageLinks": {
|
| 636 |
+
"description": "Additional URL of images of the item.",
|
| 637 |
+
"items": {
|
| 638 |
+
"type": "string"
|
| 639 |
+
},
|
| 640 |
+
"type": "array"
|
| 641 |
+
},
|
| 642 |
+
"adult": {
|
| 643 |
+
"description": "Set to true if the item is targeted towards adults.",
|
| 644 |
+
"type": "boolean"
|
| 645 |
+
},
|
| 646 |
+
"ageGroup": {
|
| 647 |
+
"description": "Target age group of the item.",
|
| 648 |
+
"type": "string"
|
| 649 |
+
},
|
| 650 |
+
"brand": {
|
| 651 |
+
"description": "Product Related Attributes.[14-36] Brand of the item.",
|
| 652 |
+
"type": "string"
|
| 653 |
+
},
|
| 654 |
+
"certifications": {
|
| 655 |
+
"description": "A list of certificates claimed by the CSS for the given product.",
|
| 656 |
+
"items": {
|
| 657 |
+
"$ref": "Certification"
|
| 658 |
+
},
|
| 659 |
+
"type": "array"
|
| 660 |
+
},
|
| 661 |
+
"color": {
|
| 662 |
+
"description": "Color of the item.",
|
| 663 |
+
"type": "string"
|
| 664 |
+
},
|
| 665 |
+
"cppAdsRedirect": {
|
| 666 |
+
"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.",
|
| 667 |
+
"type": "string"
|
| 668 |
+
},
|
| 669 |
+
"cppLink": {
|
| 670 |
+
"description": "URL directly linking to your the Product Detail Page of the CSS.",
|
| 671 |
+
"type": "string"
|
| 672 |
+
},
|
| 673 |
+
"cppMobileLink": {
|
| 674 |
+
"description": "URL for the mobile-optimized version of the Product Detail Page of the CSS.",
|
| 675 |
+
"type": "string"
|
| 676 |
+
},
|
| 677 |
+
"customLabel0": {
|
| 678 |
+
"description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
|
| 679 |
+
"type": "string"
|
| 680 |
+
},
|
| 681 |
+
"customLabel1": {
|
| 682 |
+
"description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
|
| 683 |
+
"type": "string"
|
| 684 |
+
},
|
| 685 |
+
"customLabel2": {
|
| 686 |
+
"description": "Custom label 2 for custom grouping of items in a Shopping campaign.",
|
| 687 |
+
"type": "string"
|
| 688 |
+
},
|
| 689 |
+
"customLabel3": {
|
| 690 |
+
"description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
|
| 691 |
+
"type": "string"
|
| 692 |
+
},
|
| 693 |
+
"customLabel4": {
|
| 694 |
+
"description": "Custom label 4 for custom grouping of items in a Shopping campaign.",
|
| 695 |
+
"type": "string"
|
| 696 |
+
},
|
| 697 |
+
"description": {
|
| 698 |
+
"description": "Description of the item.",
|
| 699 |
+
"type": "string"
|
| 700 |
+
},
|
| 701 |
+
"excludedDestinations": {
|
| 702 |
+
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
|
| 703 |
+
"items": {
|
| 704 |
+
"type": "string"
|
| 705 |
+
},
|
| 706 |
+
"type": "array"
|
| 707 |
+
},
|
| 708 |
+
"expirationDate": {
|
| 709 |
+
"description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.",
|
| 710 |
+
"format": "google-datetime",
|
| 711 |
+
"type": "string"
|
| 712 |
+
},
|
| 713 |
+
"gender": {
|
| 714 |
+
"description": "Target gender of the item.",
|
| 715 |
+
"type": "string"
|
| 716 |
+
},
|
| 717 |
+
"googleProductCategory": {
|
| 718 |
+
"description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.",
|
| 719 |
+
"type": "string"
|
| 720 |
+
},
|
| 721 |
+
"gtin": {
|
| 722 |
+
"description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.",
|
| 723 |
+
"type": "string"
|
| 724 |
+
},
|
| 725 |
+
"headlineOfferCondition": {
|
| 726 |
+
"description": "Condition of the headline offer.",
|
| 727 |
+
"type": "string"
|
| 728 |
+
},
|
| 729 |
+
"headlineOfferInstallment": {
|
| 730 |
+
"$ref": "HeadlineOfferInstallment",
|
| 731 |
+
"description": "Number and amount of installments to pay for an item."
|
| 732 |
+
},
|
| 733 |
+
"headlineOfferLink": {
|
| 734 |
+
"description": "Link to the headline offer.",
|
| 735 |
+
"type": "string"
|
| 736 |
+
},
|
| 737 |
+
"headlineOfferMobileLink": {
|
| 738 |
+
"description": "Mobile Link to the headline offer.",
|
| 739 |
+
"type": "string"
|
| 740 |
+
},
|
| 741 |
+
"headlineOfferPrice": {
|
| 742 |
+
"$ref": "Price",
|
| 743 |
+
"description": "Headline Price of the CSS Product."
|
| 744 |
+
},
|
| 745 |
+
"headlineOfferShippingPrice": {
|
| 746 |
+
"$ref": "Price",
|
| 747 |
+
"description": "Headline Price of the CSS Product."
|
| 748 |
+
},
|
| 749 |
+
"headlineOfferSubscriptionCost": {
|
| 750 |
+
"$ref": "HeadlineOfferSubscriptionCost",
|
| 751 |
+
"description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract."
|
| 752 |
+
},
|
| 753 |
+
"highPrice": {
|
| 754 |
+
"$ref": "Price",
|
| 755 |
+
"description": "High Price of the CSS Product."
|
| 756 |
+
},
|
| 757 |
+
"imageLink": {
|
| 758 |
+
"description": "URL of an image of the item.",
|
| 759 |
+
"type": "string"
|
| 760 |
+
},
|
| 761 |
+
"includedDestinations": {
|
| 762 |
+
"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
|
| 763 |
+
"items": {
|
| 764 |
+
"type": "string"
|
| 765 |
+
},
|
| 766 |
+
"type": "array"
|
| 767 |
+
},
|
| 768 |
+
"isBundle": {
|
| 769 |
+
"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.",
|
| 770 |
+
"type": "boolean"
|
| 771 |
+
},
|
| 772 |
+
"itemGroupId": {
|
| 773 |
+
"description": "Shared identifier for all variants of the same product.",
|
| 774 |
+
"type": "string"
|
| 775 |
+
},
|
| 776 |
+
"lowPrice": {
|
| 777 |
+
"$ref": "Price",
|
| 778 |
+
"description": "Low Price of the CSS Product."
|
| 779 |
+
},
|
| 780 |
+
"material": {
|
| 781 |
+
"description": "The material of which the item is made.",
|
| 782 |
+
"type": "string"
|
| 783 |
+
},
|
| 784 |
+
"mpn": {
|
| 785 |
+
"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.",
|
| 786 |
+
"type": "string"
|
| 787 |
+
},
|
| 788 |
+
"multipack": {
|
| 789 |
+
"description": "The number of identical products in a merchant-defined multipack.",
|
| 790 |
+
"format": "int64",
|
| 791 |
+
"type": "string"
|
| 792 |
+
},
|
| 793 |
+
"numberOfOffers": {
|
| 794 |
+
"description": "The number of CSS Products.",
|
| 795 |
+
"format": "int64",
|
| 796 |
+
"type": "string"
|
| 797 |
+
},
|
| 798 |
+
"pattern": {
|
| 799 |
+
"description": "The item's pattern (e.g. polka dots).",
|
| 800 |
+
"type": "string"
|
| 801 |
+
},
|
| 802 |
+
"pause": {
|
| 803 |
+
"description": "Publication of this item will be temporarily paused.",
|
| 804 |
+
"type": "string"
|
| 805 |
+
},
|
| 806 |
+
"productDetails": {
|
| 807 |
+
"description": "Technical specification or additional product details.",
|
| 808 |
+
"items": {
|
| 809 |
+
"$ref": "ProductDetail"
|
| 810 |
+
},
|
| 811 |
+
"type": "array"
|
| 812 |
+
},
|
| 813 |
+
"productHeight": {
|
| 814 |
+
"$ref": "ProductDimension",
|
| 815 |
+
"description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
|
| 816 |
+
},
|
| 817 |
+
"productHighlights": {
|
| 818 |
+
"description": "Bullet points describing the most relevant highlights of a product.",
|
| 819 |
+
"items": {
|
| 820 |
+
"type": "string"
|
| 821 |
+
},
|
| 822 |
+
"type": "array"
|
| 823 |
+
},
|
| 824 |
+
"productLength": {
|
| 825 |
+
"$ref": "ProductDimension",
|
| 826 |
+
"description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
|
| 827 |
+
},
|
| 828 |
+
"productTypes": {
|
| 829 |
+
"description": "Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).",
|
| 830 |
+
"items": {
|
| 831 |
+
"type": "string"
|
| 832 |
+
},
|
| 833 |
+
"type": "array"
|
| 834 |
+
},
|
| 835 |
+
"productWeight": {
|
| 836 |
+
"$ref": "ProductWeight",
|
| 837 |
+
"description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)."
|
| 838 |
+
},
|
| 839 |
+
"productWidth": {
|
| 840 |
+
"$ref": "ProductDimension",
|
| 841 |
+
"description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
|
| 842 |
+
},
|
| 843 |
+
"size": {
|
| 844 |
+
"description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).",
|
| 845 |
+
"type": "string"
|
| 846 |
+
},
|
| 847 |
+
"sizeSystem": {
|
| 848 |
+
"description": "System in which the size is specified. Recommended for apparel items.",
|
| 849 |
+
"type": "string"
|
| 850 |
+
},
|
| 851 |
+
"sizeTypes": {
|
| 852 |
+
"description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).",
|
| 853 |
+
"items": {
|
| 854 |
+
"type": "string"
|
| 855 |
+
},
|
| 856 |
+
"type": "array"
|
| 857 |
+
},
|
| 858 |
+
"title": {
|
| 859 |
+
"description": "Title of the item.",
|
| 860 |
+
"type": "string"
|
| 861 |
+
}
|
| 862 |
+
},
|
| 863 |
+
"type": "object"
|
| 864 |
+
},
|
| 865 |
+
"Certification": {
|
| 866 |
+
"description": "The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product.",
|
| 867 |
+
"id": "Certification",
|
| 868 |
+
"properties": {
|
| 869 |
+
"authority": {
|
| 870 |
+
"description": "The authority or certification body responsible for issuing the certification. At this time, the most common value is \"EC\" or \u201cEuropean_Commission\u201d for energy labels in the EU.",
|
| 871 |
+
"type": "string"
|
| 872 |
+
},
|
| 873 |
+
"code": {
|
| 874 |
+
"description": "The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels.",
|
| 875 |
+
"type": "string"
|
| 876 |
+
},
|
| 877 |
+
"name": {
|
| 878 |
+
"description": "The name of the certification. At this time, the most common value is \"EPREL\", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.",
|
| 879 |
+
"type": "string"
|
| 880 |
+
}
|
| 881 |
+
},
|
| 882 |
+
"type": "object"
|
| 883 |
+
},
|
| 884 |
+
"CssProduct": {
|
| 885 |
+
"description": "The processed CSS Product.",
|
| 886 |
+
"id": "CssProduct",
|
| 887 |
+
"properties": {
|
| 888 |
+
"attributes": {
|
| 889 |
+
"$ref": "Attributes",
|
| 890 |
+
"description": "Output only. A list of product attributes.",
|
| 891 |
+
"readOnly": true
|
| 892 |
+
},
|
| 893 |
+
"contentLanguage": {
|
| 894 |
+
"description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.",
|
| 895 |
+
"readOnly": true,
|
| 896 |
+
"type": "string"
|
| 897 |
+
},
|
| 898 |
+
"cssProductStatus": {
|
| 899 |
+
"$ref": "CssProductStatus",
|
| 900 |
+
"description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.",
|
| 901 |
+
"readOnly": true
|
| 902 |
+
},
|
| 903 |
+
"customAttributes": {
|
| 904 |
+
"description": "Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.",
|
| 905 |
+
"items": {
|
| 906 |
+
"$ref": "CustomAttribute"
|
| 907 |
+
},
|
| 908 |
+
"readOnly": true,
|
| 909 |
+
"type": "array"
|
| 910 |
+
},
|
| 911 |
+
"feedLabel": {
|
| 912 |
+
"description": "Output only. The feed label for the product.",
|
| 913 |
+
"readOnly": true,
|
| 914 |
+
"type": "string"
|
| 915 |
+
},
|
| 916 |
+
"name": {
|
| 917 |
+
"description": "The name of the CSS Product. Format: `\"accounts/{account}/cssProducts/{css_product}\"`",
|
| 918 |
+
"type": "string"
|
| 919 |
+
},
|
| 920 |
+
"rawProvidedId": {
|
| 921 |
+
"description": "Output only. Your unique raw identifier for the product.",
|
| 922 |
+
"readOnly": true,
|
| 923 |
+
"type": "string"
|
| 924 |
+
}
|
| 925 |
+
},
|
| 926 |
+
"type": "object"
|
| 927 |
+
},
|
| 928 |
+
"CssProductInput": {
|
| 929 |
+
"description": "This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.",
|
| 930 |
+
"id": "CssProductInput",
|
| 931 |
+
"properties": {
|
| 932 |
+
"attributes": {
|
| 933 |
+
"$ref": "Attributes",
|
| 934 |
+
"description": "A list of CSS Product attributes."
|
| 935 |
+
},
|
| 936 |
+
"contentLanguage": {
|
| 937 |
+
"description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.",
|
| 938 |
+
"type": "string"
|
| 939 |
+
},
|
| 940 |
+
"customAttributes": {
|
| 941 |
+
"description": "A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.",
|
| 942 |
+
"items": {
|
| 943 |
+
"$ref": "CustomAttribute"
|
| 944 |
+
},
|
| 945 |
+
"type": "array"
|
| 946 |
+
},
|
| 947 |
+
"feedLabel": {
|
| 948 |
+
"description": "Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to \"target country\" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.",
|
| 949 |
+
"type": "string"
|
| 950 |
+
},
|
| 951 |
+
"finalName": {
|
| 952 |
+
"description": "Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` \"",
|
| 953 |
+
"readOnly": true,
|
| 954 |
+
"type": "string"
|
| 955 |
+
},
|
| 956 |
+
"freshnessTime": {
|
| 957 |
+
"deprecated": true,
|
| 958 |
+
"description": "DEPRECATED. Use expiration_date instead. Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.",
|
| 959 |
+
"format": "google-datetime",
|
| 960 |
+
"type": "string"
|
| 961 |
+
},
|
| 962 |
+
"name": {
|
| 963 |
+
"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`",
|
| 964 |
+
"type": "string"
|
| 965 |
+
},
|
| 966 |
+
"rawProvidedId": {
|
| 967 |
+
"description": "Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.",
|
| 968 |
+
"type": "string"
|
| 969 |
+
}
|
| 970 |
+
},
|
| 971 |
+
"type": "object"
|
| 972 |
+
},
|
| 973 |
+
"CssProductStatus": {
|
| 974 |
+
"description": "The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.",
|
| 975 |
+
"id": "CssProductStatus",
|
| 976 |
+
"properties": {
|
| 977 |
+
"creationDate": {
|
| 978 |
+
"description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.",
|
| 979 |
+
"format": "google-datetime",
|
| 980 |
+
"type": "string"
|
| 981 |
+
},
|
| 982 |
+
"destinationStatuses": {
|
| 983 |
+
"description": "The intended destinations for the product.",
|
| 984 |
+
"items": {
|
| 985 |
+
"$ref": "DestinationStatus"
|
| 986 |
+
},
|
| 987 |
+
"type": "array"
|
| 988 |
+
},
|
| 989 |
+
"googleExpirationDate": {
|
| 990 |
+
"description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.",
|
| 991 |
+
"format": "google-datetime",
|
| 992 |
+
"type": "string"
|
| 993 |
+
},
|
| 994 |
+
"itemLevelIssues": {
|
| 995 |
+
"description": "A list of all issues associated with the product.",
|
| 996 |
+
"items": {
|
| 997 |
+
"$ref": "ItemLevelIssue"
|
| 998 |
+
},
|
| 999 |
+
"type": "array"
|
| 1000 |
+
},
|
| 1001 |
+
"lastUpdateDate": {
|
| 1002 |
+
"description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.",
|
| 1003 |
+
"format": "google-datetime",
|
| 1004 |
+
"type": "string"
|
| 1005 |
+
}
|
| 1006 |
+
},
|
| 1007 |
+
"type": "object"
|
| 1008 |
+
},
|
| 1009 |
+
"CustomAttribute": {
|
| 1010 |
+
"description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.",
|
| 1011 |
+
"id": "CustomAttribute",
|
| 1012 |
+
"properties": {
|
| 1013 |
+
"groupValues": {
|
| 1014 |
+
"description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.",
|
| 1015 |
+
"items": {
|
| 1016 |
+
"$ref": "CustomAttribute"
|
| 1017 |
+
},
|
| 1018 |
+
"type": "array"
|
| 1019 |
+
},
|
| 1020 |
+
"name": {
|
| 1021 |
+
"description": "The name of the attribute.",
|
| 1022 |
+
"type": "string"
|
| 1023 |
+
},
|
| 1024 |
+
"value": {
|
| 1025 |
+
"description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.",
|
| 1026 |
+
"type": "string"
|
| 1027 |
+
}
|
| 1028 |
+
},
|
| 1029 |
+
"type": "object"
|
| 1030 |
+
},
|
| 1031 |
+
"DestinationStatus": {
|
| 1032 |
+
"description": "The destination status of the product status.",
|
| 1033 |
+
"id": "DestinationStatus",
|
| 1034 |
+
"properties": {
|
| 1035 |
+
"approvedCountries": {
|
| 1036 |
+
"description": "List of country codes (ISO 3166-1 alpha-2) where the CSS Product is approved.",
|
| 1037 |
+
"items": {
|
| 1038 |
+
"type": "string"
|
| 1039 |
+
},
|
| 1040 |
+
"type": "array"
|
| 1041 |
+
},
|
| 1042 |
+
"destination": {
|
| 1043 |
+
"description": "The name of the destination",
|
| 1044 |
+
"type": "string"
|
| 1045 |
+
},
|
| 1046 |
+
"disapprovedCountries": {
|
| 1047 |
+
"description": "List of country codes (ISO 3166-1 alpha-2) where the CSS Product is disapproved.",
|
| 1048 |
+
"items": {
|
| 1049 |
+
"type": "string"
|
| 1050 |
+
},
|
| 1051 |
+
"type": "array"
|
| 1052 |
+
},
|
| 1053 |
+
"pendingCountries": {
|
| 1054 |
+
"description": "List of country codes (ISO 3166-1 alpha-2) where the CSS Product is pending approval.",
|
| 1055 |
+
"items": {
|
| 1056 |
+
"type": "string"
|
| 1057 |
+
},
|
| 1058 |
+
"type": "array"
|
| 1059 |
+
}
|
| 1060 |
+
},
|
| 1061 |
+
"type": "object"
|
| 1062 |
+
},
|
| 1063 |
+
"Empty": {
|
| 1064 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 1065 |
+
"id": "Empty",
|
| 1066 |
+
"properties": {},
|
| 1067 |
+
"type": "object"
|
| 1068 |
+
},
|
| 1069 |
+
"HeadlineOfferInstallment": {
|
| 1070 |
+
"description": "A message that represents installment.",
|
| 1071 |
+
"id": "HeadlineOfferInstallment",
|
| 1072 |
+
"properties": {
|
| 1073 |
+
"amount": {
|
| 1074 |
+
"$ref": "Price",
|
| 1075 |
+
"description": "The amount the buyer has to pay per month."
|
| 1076 |
+
},
|
| 1077 |
+
"downpayment": {
|
| 1078 |
+
"$ref": "Price",
|
| 1079 |
+
"description": "The up-front down payment amount the buyer has to pay."
|
| 1080 |
+
},
|
| 1081 |
+
"months": {
|
| 1082 |
+
"description": "The number of installments the buyer has to pay.",
|
| 1083 |
+
"format": "int64",
|
| 1084 |
+
"type": "string"
|
| 1085 |
+
}
|
| 1086 |
+
},
|
| 1087 |
+
"type": "object"
|
| 1088 |
+
},
|
| 1089 |
+
"HeadlineOfferSubscriptionCost": {
|
| 1090 |
+
"description": "The SubscriptionCost of the product.",
|
| 1091 |
+
"id": "HeadlineOfferSubscriptionCost",
|
| 1092 |
+
"properties": {
|
| 1093 |
+
"amount": {
|
| 1094 |
+
"$ref": "Price",
|
| 1095 |
+
"description": "The amount the buyer has to pay per subscription period."
|
| 1096 |
+
},
|
| 1097 |
+
"period": {
|
| 1098 |
+
"description": "The type of subscription period. Supported values are: * \"`month`\" * \"`year`\"",
|
| 1099 |
+
"enum": [
|
| 1100 |
+
"SUBSCRIPTION_PERIOD_UNSPECIFIED",
|
| 1101 |
+
"MONTH",
|
| 1102 |
+
"YEAR"
|
| 1103 |
+
],
|
| 1104 |
+
"enumDescriptions": [
|
| 1105 |
+
"Indicates that the subscription period is unspecified.",
|
| 1106 |
+
"Indicates that the subscription period is month.",
|
| 1107 |
+
"Indicates that the subscription period is year."
|
| 1108 |
+
],
|
| 1109 |
+
"type": "string"
|
| 1110 |
+
},
|
| 1111 |
+
"periodLength": {
|
| 1112 |
+
"description": "The number of subscription periods the buyer has to pay.",
|
| 1113 |
+
"format": "int64",
|
| 1114 |
+
"type": "string"
|
| 1115 |
+
}
|
| 1116 |
+
},
|
| 1117 |
+
"type": "object"
|
| 1118 |
+
},
|
| 1119 |
+
"ItemLevelIssue": {
|
| 1120 |
+
"description": "The ItemLevelIssue of the product status.",
|
| 1121 |
+
"id": "ItemLevelIssue",
|
| 1122 |
+
"properties": {
|
| 1123 |
+
"applicableCountries": {
|
| 1124 |
+
"description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the CSS Product.",
|
| 1125 |
+
"items": {
|
| 1126 |
+
"type": "string"
|
| 1127 |
+
},
|
| 1128 |
+
"type": "array"
|
| 1129 |
+
},
|
| 1130 |
+
"attribute": {
|
| 1131 |
+
"description": "The attribute's name, if the issue is caused by a single attribute.",
|
| 1132 |
+
"type": "string"
|
| 1133 |
+
},
|
| 1134 |
+
"code": {
|
| 1135 |
+
"description": "The error code of the issue.",
|
| 1136 |
+
"type": "string"
|
| 1137 |
+
},
|
| 1138 |
+
"description": {
|
| 1139 |
+
"description": "A short issue description in English.",
|
| 1140 |
+
"type": "string"
|
| 1141 |
+
},
|
| 1142 |
+
"destination": {
|
| 1143 |
+
"description": "The destination the issue applies to.",
|
| 1144 |
+
"type": "string"
|
| 1145 |
+
},
|
| 1146 |
+
"detail": {
|
| 1147 |
+
"description": "A detailed issue description in English.",
|
| 1148 |
+
"type": "string"
|
| 1149 |
+
},
|
| 1150 |
+
"documentation": {
|
| 1151 |
+
"description": "The URL of a web page to help with resolving this issue.",
|
| 1152 |
+
"type": "string"
|
| 1153 |
+
},
|
| 1154 |
+
"resolution": {
|
| 1155 |
+
"description": "Whether the issue can be resolved by the merchant.",
|
| 1156 |
+
"type": "string"
|
| 1157 |
+
},
|
| 1158 |
+
"servability": {
|
| 1159 |
+
"description": "How this issue affects serving of the CSS Product.",
|
| 1160 |
+
"type": "string"
|
| 1161 |
+
}
|
| 1162 |
+
},
|
| 1163 |
+
"type": "object"
|
| 1164 |
+
},
|
| 1165 |
+
"ListAccountLabelsResponse": {
|
| 1166 |
+
"description": "Response message for the `ListAccountLabels` method.",
|
| 1167 |
+
"id": "ListAccountLabelsResponse",
|
| 1168 |
+
"properties": {
|
| 1169 |
+
"accountLabels": {
|
| 1170 |
+
"description": "The labels from the specified account.",
|
| 1171 |
+
"items": {
|
| 1172 |
+
"$ref": "AccountLabel"
|
| 1173 |
+
},
|
| 1174 |
+
"type": "array"
|
| 1175 |
+
},
|
| 1176 |
+
"nextPageToken": {
|
| 1177 |
+
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
| 1178 |
+
"type": "string"
|
| 1179 |
+
}
|
| 1180 |
+
},
|
| 1181 |
+
"type": "object"
|
| 1182 |
+
},
|
| 1183 |
+
"ListChildAccountsResponse": {
|
| 1184 |
+
"description": "Response message for the `ListChildAccounts` method.",
|
| 1185 |
+
"id": "ListChildAccountsResponse",
|
| 1186 |
+
"properties": {
|
| 1187 |
+
"accounts": {
|
| 1188 |
+
"description": "The CSS/MC accounts returned for the specified CSS parent account.",
|
| 1189 |
+
"items": {
|
| 1190 |
+
"$ref": "Account"
|
| 1191 |
+
},
|
| 1192 |
+
"type": "array"
|
| 1193 |
+
},
|
| 1194 |
+
"nextPageToken": {
|
| 1195 |
+
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
| 1196 |
+
"type": "string"
|
| 1197 |
+
}
|
| 1198 |
+
},
|
| 1199 |
+
"type": "object"
|
| 1200 |
+
},
|
| 1201 |
+
"ListCssProductsResponse": {
|
| 1202 |
+
"description": "Response message for the ListCssProducts method.",
|
| 1203 |
+
"id": "ListCssProductsResponse",
|
| 1204 |
+
"properties": {
|
| 1205 |
+
"cssProducts": {
|
| 1206 |
+
"description": "The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.",
|
| 1207 |
+
"items": {
|
| 1208 |
+
"$ref": "CssProduct"
|
| 1209 |
+
},
|
| 1210 |
+
"type": "array"
|
| 1211 |
+
},
|
| 1212 |
+
"nextPageToken": {
|
| 1213 |
+
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
| 1214 |
+
"type": "string"
|
| 1215 |
+
}
|
| 1216 |
+
},
|
| 1217 |
+
"type": "object"
|
| 1218 |
+
},
|
| 1219 |
+
"Price": {
|
| 1220 |
+
"description": "The price represented as a number and currency.",
|
| 1221 |
+
"id": "Price",
|
| 1222 |
+
"properties": {
|
| 1223 |
+
"amountMicros": {
|
| 1224 |
+
"description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).",
|
| 1225 |
+
"format": "int64",
|
| 1226 |
+
"type": "string"
|
| 1227 |
+
},
|
| 1228 |
+
"currencyCode": {
|
| 1229 |
+
"description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).",
|
| 1230 |
+
"type": "string"
|
| 1231 |
+
}
|
| 1232 |
+
},
|
| 1233 |
+
"type": "object"
|
| 1234 |
+
},
|
| 1235 |
+
"ProductDetail": {
|
| 1236 |
+
"description": "The product details.",
|
| 1237 |
+
"id": "ProductDetail",
|
| 1238 |
+
"properties": {
|
| 1239 |
+
"attributeName": {
|
| 1240 |
+
"description": "The name of the product detail.",
|
| 1241 |
+
"type": "string"
|
| 1242 |
+
},
|
| 1243 |
+
"attributeValue": {
|
| 1244 |
+
"description": "The value of the product detail.",
|
| 1245 |
+
"type": "string"
|
| 1246 |
+
},
|
| 1247 |
+
"sectionName": {
|
| 1248 |
+
"description": "The section header used to group a set of product details.",
|
| 1249 |
+
"type": "string"
|
| 1250 |
+
}
|
| 1251 |
+
},
|
| 1252 |
+
"type": "object"
|
| 1253 |
+
},
|
| 1254 |
+
"ProductDimension": {
|
| 1255 |
+
"description": "The dimension of the product.",
|
| 1256 |
+
"id": "ProductDimension",
|
| 1257 |
+
"properties": {
|
| 1258 |
+
"unit": {
|
| 1259 |
+
"description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"",
|
| 1260 |
+
"type": "string"
|
| 1261 |
+
},
|
| 1262 |
+
"value": {
|
| 1263 |
+
"description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.",
|
| 1264 |
+
"format": "double",
|
| 1265 |
+
"type": "number"
|
| 1266 |
+
}
|
| 1267 |
+
},
|
| 1268 |
+
"type": "object"
|
| 1269 |
+
},
|
| 1270 |
+
"ProductWeight": {
|
| 1271 |
+
"description": "The weight of the product.",
|
| 1272 |
+
"id": "ProductWeight",
|
| 1273 |
+
"properties": {
|
| 1274 |
+
"unit": {
|
| 1275 |
+
"description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"",
|
| 1276 |
+
"type": "string"
|
| 1277 |
+
},
|
| 1278 |
+
"value": {
|
| 1279 |
+
"description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.",
|
| 1280 |
+
"format": "double",
|
| 1281 |
+
"type": "number"
|
| 1282 |
+
}
|
| 1283 |
+
},
|
| 1284 |
+
"type": "object"
|
| 1285 |
+
},
|
| 1286 |
+
"UpdateAccountLabelsRequest": {
|
| 1287 |
+
"description": "The request message for the `UpdateLabels` method.",
|
| 1288 |
+
"id": "UpdateAccountLabelsRequest",
|
| 1289 |
+
"properties": {
|
| 1290 |
+
"labelIds": {
|
| 1291 |
+
"description": "The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.",
|
| 1292 |
+
"items": {
|
| 1293 |
+
"format": "int64",
|
| 1294 |
+
"type": "string"
|
| 1295 |
+
},
|
| 1296 |
+
"type": "array"
|
| 1297 |
+
},
|
| 1298 |
+
"parent": {
|
| 1299 |
+
"description": "Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}",
|
| 1300 |
+
"type": "string"
|
| 1301 |
+
}
|
| 1302 |
+
},
|
| 1303 |
+
"type": "object"
|
| 1304 |
+
}
|
| 1305 |
+
},
|
| 1306 |
+
"servicePath": "",
|
| 1307 |
+
"title": "CSS API",
|
| 1308 |
+
"version": "v1",
|
| 1309 |
+
"version_module": true
|
| 1310 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/customsearch.v1.json
ADDED
|
@@ -0,0 +1,1480 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"basePath": "",
|
| 3 |
+
"baseUrl": "https://customsearch.googleapis.com/",
|
| 4 |
+
"batchPath": "batch",
|
| 5 |
+
"canonicalName": "CustomSearch API",
|
| 6 |
+
"description": "Searches over a website or collection of websites",
|
| 7 |
+
"discoveryVersion": "v1",
|
| 8 |
+
"documentationLink": "https://developers.google.com/custom-search/v1/introduction",
|
| 9 |
+
"icons": {
|
| 10 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 11 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 12 |
+
},
|
| 13 |
+
"id": "customsearch:v1",
|
| 14 |
+
"kind": "discovery#restDescription",
|
| 15 |
+
"mtlsRootUrl": "https://customsearch.mtls.googleapis.com/",
|
| 16 |
+
"name": "customsearch",
|
| 17 |
+
"ownerDomain": "google.com",
|
| 18 |
+
"ownerName": "Google",
|
| 19 |
+
"parameters": {
|
| 20 |
+
"$.xgafv": {
|
| 21 |
+
"description": "V1 error format.",
|
| 22 |
+
"enum": [
|
| 23 |
+
"1",
|
| 24 |
+
"2"
|
| 25 |
+
],
|
| 26 |
+
"enumDescriptions": [
|
| 27 |
+
"v1 error format",
|
| 28 |
+
"v2 error format"
|
| 29 |
+
],
|
| 30 |
+
"location": "query",
|
| 31 |
+
"type": "string"
|
| 32 |
+
},
|
| 33 |
+
"access_token": {
|
| 34 |
+
"description": "OAuth access token.",
|
| 35 |
+
"location": "query",
|
| 36 |
+
"type": "string"
|
| 37 |
+
},
|
| 38 |
+
"alt": {
|
| 39 |
+
"default": "json",
|
| 40 |
+
"description": "Data format for response.",
|
| 41 |
+
"enum": [
|
| 42 |
+
"json",
|
| 43 |
+
"media",
|
| 44 |
+
"proto"
|
| 45 |
+
],
|
| 46 |
+
"enumDescriptions": [
|
| 47 |
+
"Responses with Content-Type of application/json",
|
| 48 |
+
"Media download with context-dependent Content-Type",
|
| 49 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 50 |
+
],
|
| 51 |
+
"location": "query",
|
| 52 |
+
"type": "string"
|
| 53 |
+
},
|
| 54 |
+
"callback": {
|
| 55 |
+
"description": "JSONP",
|
| 56 |
+
"location": "query",
|
| 57 |
+
"type": "string"
|
| 58 |
+
},
|
| 59 |
+
"fields": {
|
| 60 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"key": {
|
| 65 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"oauth_token": {
|
| 70 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"prettyPrint": {
|
| 75 |
+
"default": "true",
|
| 76 |
+
"description": "Returns response with indentations and line breaks.",
|
| 77 |
+
"location": "query",
|
| 78 |
+
"type": "boolean"
|
| 79 |
+
},
|
| 80 |
+
"quotaUser": {
|
| 81 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 82 |
+
"location": "query",
|
| 83 |
+
"type": "string"
|
| 84 |
+
},
|
| 85 |
+
"uploadType": {
|
| 86 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "string"
|
| 89 |
+
},
|
| 90 |
+
"upload_protocol": {
|
| 91 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
}
|
| 95 |
+
},
|
| 96 |
+
"protocol": "rest",
|
| 97 |
+
"resources": {
|
| 98 |
+
"cse": {
|
| 99 |
+
"methods": {
|
| 100 |
+
"list": {
|
| 101 |
+
"description": "Returns metadata about the search performed, metadata about the engine used for the search, and the search results.",
|
| 102 |
+
"flatPath": "customsearch/v1",
|
| 103 |
+
"httpMethod": "GET",
|
| 104 |
+
"id": "search.cse.list",
|
| 105 |
+
"parameterOrder": [],
|
| 106 |
+
"parameters": {
|
| 107 |
+
"c2coff": {
|
| 108 |
+
"description": "Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)",
|
| 109 |
+
"location": "query",
|
| 110 |
+
"type": "string"
|
| 111 |
+
},
|
| 112 |
+
"cr": {
|
| 113 |
+
"description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.",
|
| 114 |
+
"location": "query",
|
| 115 |
+
"type": "string"
|
| 116 |
+
},
|
| 117 |
+
"cx": {
|
| 118 |
+
"description": "The Programmable Search Engine ID to use for this request.",
|
| 119 |
+
"location": "query",
|
| 120 |
+
"type": "string"
|
| 121 |
+
},
|
| 122 |
+
"dateRestrict": {
|
| 123 |
+
"description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.",
|
| 124 |
+
"location": "query",
|
| 125 |
+
"type": "string"
|
| 126 |
+
},
|
| 127 |
+
"enableAlternateSearchHandler": {
|
| 128 |
+
"description": "Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.",
|
| 129 |
+
"location": "query",
|
| 130 |
+
"type": "boolean"
|
| 131 |
+
},
|
| 132 |
+
"exactTerms": {
|
| 133 |
+
"description": "Identifies a phrase that all documents in the search results must contain.",
|
| 134 |
+
"location": "query",
|
| 135 |
+
"type": "string"
|
| 136 |
+
},
|
| 137 |
+
"excludeTerms": {
|
| 138 |
+
"description": "Identifies a word or phrase that should not appear in any documents in the search results.",
|
| 139 |
+
"location": "query",
|
| 140 |
+
"type": "string"
|
| 141 |
+
},
|
| 142 |
+
"fileType": {
|
| 143 |
+
"description": "Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).",
|
| 144 |
+
"location": "query",
|
| 145 |
+
"type": "string"
|
| 146 |
+
},
|
| 147 |
+
"filter": {
|
| 148 |
+
"description": "Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.",
|
| 149 |
+
"location": "query",
|
| 150 |
+
"type": "string"
|
| 151 |
+
},
|
| 152 |
+
"gl": {
|
| 153 |
+
"description": "Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.",
|
| 154 |
+
"location": "query",
|
| 155 |
+
"type": "string"
|
| 156 |
+
},
|
| 157 |
+
"googlehost": {
|
| 158 |
+
"description": "**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.",
|
| 159 |
+
"location": "query",
|
| 160 |
+
"type": "string"
|
| 161 |
+
},
|
| 162 |
+
"highRange": {
|
| 163 |
+
"description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 164 |
+
"location": "query",
|
| 165 |
+
"type": "string"
|
| 166 |
+
},
|
| 167 |
+
"hl": {
|
| 168 |
+
"description": "Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.",
|
| 169 |
+
"location": "query",
|
| 170 |
+
"type": "string"
|
| 171 |
+
},
|
| 172 |
+
"hq": {
|
| 173 |
+
"description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.",
|
| 174 |
+
"location": "query",
|
| 175 |
+
"type": "string"
|
| 176 |
+
},
|
| 177 |
+
"imgColorType": {
|
| 178 |
+
"description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background",
|
| 179 |
+
"enum": [
|
| 180 |
+
"imgColorTypeUndefined",
|
| 181 |
+
"mono",
|
| 182 |
+
"gray",
|
| 183 |
+
"color",
|
| 184 |
+
"trans"
|
| 185 |
+
],
|
| 186 |
+
"enumDescriptions": [
|
| 187 |
+
"No image color type specified.",
|
| 188 |
+
"Black and white images only.",
|
| 189 |
+
"Grayscale images only.",
|
| 190 |
+
"Color images only.",
|
| 191 |
+
"Images with transparent background"
|
| 192 |
+
],
|
| 193 |
+
"location": "query",
|
| 194 |
+
"type": "string"
|
| 195 |
+
},
|
| 196 |
+
"imgDominantColor": {
|
| 197 |
+
"description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`",
|
| 198 |
+
"enum": [
|
| 199 |
+
"imgDominantColorUndefined",
|
| 200 |
+
"black",
|
| 201 |
+
"blue",
|
| 202 |
+
"brown",
|
| 203 |
+
"gray",
|
| 204 |
+
"green",
|
| 205 |
+
"orange",
|
| 206 |
+
"pink",
|
| 207 |
+
"purple",
|
| 208 |
+
"red",
|
| 209 |
+
"teal",
|
| 210 |
+
"white",
|
| 211 |
+
"yellow"
|
| 212 |
+
],
|
| 213 |
+
"enumDescriptions": [
|
| 214 |
+
"No dominant color specified.",
|
| 215 |
+
"Predominantly black images only.",
|
| 216 |
+
"Predominantly blue images only.",
|
| 217 |
+
"Predominantly brown images only.",
|
| 218 |
+
"Predominantly gray images only.",
|
| 219 |
+
"Predominantly green images only.",
|
| 220 |
+
"Predominantly orange images only.",
|
| 221 |
+
"Predominantly pink images only.",
|
| 222 |
+
"Predominantly purple images only.",
|
| 223 |
+
"Predominantly red images only.",
|
| 224 |
+
"Predominantly teal images only.",
|
| 225 |
+
"Predominantly white images only.",
|
| 226 |
+
"Predominantly yellow images only."
|
| 227 |
+
],
|
| 228 |
+
"location": "query",
|
| 229 |
+
"type": "string"
|
| 230 |
+
},
|
| 231 |
+
"imgSize": {
|
| 232 |
+
"description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`",
|
| 233 |
+
"enum": [
|
| 234 |
+
"imgSizeUndefined",
|
| 235 |
+
"HUGE",
|
| 236 |
+
"ICON",
|
| 237 |
+
"LARGE",
|
| 238 |
+
"MEDIUM",
|
| 239 |
+
"SMALL",
|
| 240 |
+
"XLARGE",
|
| 241 |
+
"XXLARGE"
|
| 242 |
+
],
|
| 243 |
+
"enumDescriptions": [
|
| 244 |
+
"No image size specified.",
|
| 245 |
+
"Only the largest possible images.",
|
| 246 |
+
"Only very small icon-sized images.",
|
| 247 |
+
"Only large images.",
|
| 248 |
+
"Only medium images.",
|
| 249 |
+
"Only small images.",
|
| 250 |
+
"Only very large images.",
|
| 251 |
+
"Only extremely large images."
|
| 252 |
+
],
|
| 253 |
+
"location": "query",
|
| 254 |
+
"type": "string"
|
| 255 |
+
},
|
| 256 |
+
"imgType": {
|
| 257 |
+
"description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`",
|
| 258 |
+
"enum": [
|
| 259 |
+
"imgTypeUndefined",
|
| 260 |
+
"clipart",
|
| 261 |
+
"face",
|
| 262 |
+
"lineart",
|
| 263 |
+
"stock",
|
| 264 |
+
"photo",
|
| 265 |
+
"animated"
|
| 266 |
+
],
|
| 267 |
+
"enumDescriptions": [
|
| 268 |
+
"No image type specified.",
|
| 269 |
+
"Clipart-style images only.",
|
| 270 |
+
"Images of faces only.",
|
| 271 |
+
"Line art images only.",
|
| 272 |
+
"Stock images only.",
|
| 273 |
+
"Photo images only.",
|
| 274 |
+
"Animated images only."
|
| 275 |
+
],
|
| 276 |
+
"location": "query",
|
| 277 |
+
"type": "string"
|
| 278 |
+
},
|
| 279 |
+
"linkSite": {
|
| 280 |
+
"description": "Specifies that all search results should contain a link to a particular URL.",
|
| 281 |
+
"location": "query",
|
| 282 |
+
"type": "string"
|
| 283 |
+
},
|
| 284 |
+
"lowRange": {
|
| 285 |
+
"description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 286 |
+
"location": "query",
|
| 287 |
+
"type": "string"
|
| 288 |
+
},
|
| 289 |
+
"lr": {
|
| 290 |
+
"description": "Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)",
|
| 291 |
+
"location": "query",
|
| 292 |
+
"type": "string"
|
| 293 |
+
},
|
| 294 |
+
"num": {
|
| 295 |
+
"description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.",
|
| 296 |
+
"format": "int32",
|
| 297 |
+
"location": "query",
|
| 298 |
+
"type": "integer"
|
| 299 |
+
},
|
| 300 |
+
"orTerms": {
|
| 301 |
+
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.",
|
| 302 |
+
"location": "query",
|
| 303 |
+
"type": "string"
|
| 304 |
+
},
|
| 305 |
+
"q": {
|
| 306 |
+
"description": "Query",
|
| 307 |
+
"location": "query",
|
| 308 |
+
"type": "string"
|
| 309 |
+
},
|
| 310 |
+
"relatedSite": {
|
| 311 |
+
"deprecated": true,
|
| 312 |
+
"description": "Deprecated.",
|
| 313 |
+
"location": "query",
|
| 314 |
+
"type": "string"
|
| 315 |
+
},
|
| 316 |
+
"rights": {
|
| 317 |
+
"description": "Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).",
|
| 318 |
+
"location": "query",
|
| 319 |
+
"type": "string"
|
| 320 |
+
},
|
| 321 |
+
"safe": {
|
| 322 |
+
"description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)",
|
| 323 |
+
"enum": [
|
| 324 |
+
"safeUndefined",
|
| 325 |
+
"active",
|
| 326 |
+
"high",
|
| 327 |
+
"medium",
|
| 328 |
+
"off"
|
| 329 |
+
],
|
| 330 |
+
"enumDeprecated": [
|
| 331 |
+
false,
|
| 332 |
+
false,
|
| 333 |
+
true,
|
| 334 |
+
true,
|
| 335 |
+
false
|
| 336 |
+
],
|
| 337 |
+
"enumDescriptions": [
|
| 338 |
+
"SafeSearch mode unspecified. (Falls back to engine's configuration.)",
|
| 339 |
+
"Turn SafeSearch on.",
|
| 340 |
+
"Deprecated, equivalent to \"active\".",
|
| 341 |
+
"Deprecated, equivalent to \"active\".",
|
| 342 |
+
"Turn SafeSearch off."
|
| 343 |
+
],
|
| 344 |
+
"location": "query",
|
| 345 |
+
"type": "string"
|
| 346 |
+
},
|
| 347 |
+
"searchType": {
|
| 348 |
+
"description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.",
|
| 349 |
+
"enum": [
|
| 350 |
+
"searchTypeUndefined",
|
| 351 |
+
"image"
|
| 352 |
+
],
|
| 353 |
+
"enumDescriptions": [
|
| 354 |
+
"Search type unspecified (defaults to web search).",
|
| 355 |
+
"Image search."
|
| 356 |
+
],
|
| 357 |
+
"location": "query",
|
| 358 |
+
"type": "string"
|
| 359 |
+
},
|
| 360 |
+
"siteSearch": {
|
| 361 |
+
"description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).",
|
| 362 |
+
"location": "query",
|
| 363 |
+
"type": "string"
|
| 364 |
+
},
|
| 365 |
+
"siteSearchFilter": {
|
| 366 |
+
"description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include",
|
| 367 |
+
"enum": [
|
| 368 |
+
"siteSearchFilterUndefined",
|
| 369 |
+
"e",
|
| 370 |
+
"i"
|
| 371 |
+
],
|
| 372 |
+
"enumDescriptions": [
|
| 373 |
+
"Filter mode unspecified.",
|
| 374 |
+
"Exclude results from the listed sites.",
|
| 375 |
+
"Include only results from the listed sites."
|
| 376 |
+
],
|
| 377 |
+
"location": "query",
|
| 378 |
+
"type": "string"
|
| 379 |
+
},
|
| 380 |
+
"snippetLength": {
|
| 381 |
+
"description": "Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.",
|
| 382 |
+
"format": "int32",
|
| 383 |
+
"location": "query",
|
| 384 |
+
"type": "integer"
|
| 385 |
+
},
|
| 386 |
+
"sort": {
|
| 387 |
+
"description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).",
|
| 388 |
+
"location": "query",
|
| 389 |
+
"type": "string"
|
| 390 |
+
},
|
| 391 |
+
"start": {
|
| 392 |
+
"description": "The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.",
|
| 393 |
+
"format": "uint32",
|
| 394 |
+
"location": "query",
|
| 395 |
+
"type": "integer"
|
| 396 |
+
}
|
| 397 |
+
},
|
| 398 |
+
"path": "customsearch/v1",
|
| 399 |
+
"response": {
|
| 400 |
+
"$ref": "Search"
|
| 401 |
+
}
|
| 402 |
+
}
|
| 403 |
+
},
|
| 404 |
+
"resources": {
|
| 405 |
+
"siterestrict": {
|
| 406 |
+
"methods": {
|
| 407 |
+
"list": {
|
| 408 |
+
"description": "Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.",
|
| 409 |
+
"flatPath": "customsearch/v1/siterestrict",
|
| 410 |
+
"httpMethod": "GET",
|
| 411 |
+
"id": "search.cse.siterestrict.list",
|
| 412 |
+
"parameterOrder": [],
|
| 413 |
+
"parameters": {
|
| 414 |
+
"c2coff": {
|
| 415 |
+
"description": "Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)",
|
| 416 |
+
"location": "query",
|
| 417 |
+
"type": "string"
|
| 418 |
+
},
|
| 419 |
+
"cr": {
|
| 420 |
+
"description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.",
|
| 421 |
+
"location": "query",
|
| 422 |
+
"type": "string"
|
| 423 |
+
},
|
| 424 |
+
"cx": {
|
| 425 |
+
"description": "The Programmable Search Engine ID to use for this request.",
|
| 426 |
+
"location": "query",
|
| 427 |
+
"type": "string"
|
| 428 |
+
},
|
| 429 |
+
"dateRestrict": {
|
| 430 |
+
"description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.",
|
| 431 |
+
"location": "query",
|
| 432 |
+
"type": "string"
|
| 433 |
+
},
|
| 434 |
+
"enableAlternateSearchHandler": {
|
| 435 |
+
"description": "Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.",
|
| 436 |
+
"location": "query",
|
| 437 |
+
"type": "boolean"
|
| 438 |
+
},
|
| 439 |
+
"exactTerms": {
|
| 440 |
+
"description": "Identifies a phrase that all documents in the search results must contain.",
|
| 441 |
+
"location": "query",
|
| 442 |
+
"type": "string"
|
| 443 |
+
},
|
| 444 |
+
"excludeTerms": {
|
| 445 |
+
"description": "Identifies a word or phrase that should not appear in any documents in the search results.",
|
| 446 |
+
"location": "query",
|
| 447 |
+
"type": "string"
|
| 448 |
+
},
|
| 449 |
+
"fileType": {
|
| 450 |
+
"description": "Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).",
|
| 451 |
+
"location": "query",
|
| 452 |
+
"type": "string"
|
| 453 |
+
},
|
| 454 |
+
"filter": {
|
| 455 |
+
"description": "Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.",
|
| 456 |
+
"location": "query",
|
| 457 |
+
"type": "string"
|
| 458 |
+
},
|
| 459 |
+
"gl": {
|
| 460 |
+
"description": "Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.",
|
| 461 |
+
"location": "query",
|
| 462 |
+
"type": "string"
|
| 463 |
+
},
|
| 464 |
+
"googlehost": {
|
| 465 |
+
"description": "**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.",
|
| 466 |
+
"location": "query",
|
| 467 |
+
"type": "string"
|
| 468 |
+
},
|
| 469 |
+
"highRange": {
|
| 470 |
+
"description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 471 |
+
"location": "query",
|
| 472 |
+
"type": "string"
|
| 473 |
+
},
|
| 474 |
+
"hl": {
|
| 475 |
+
"description": "Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.",
|
| 476 |
+
"location": "query",
|
| 477 |
+
"type": "string"
|
| 478 |
+
},
|
| 479 |
+
"hq": {
|
| 480 |
+
"description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.",
|
| 481 |
+
"location": "query",
|
| 482 |
+
"type": "string"
|
| 483 |
+
},
|
| 484 |
+
"imgColorType": {
|
| 485 |
+
"description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background",
|
| 486 |
+
"enum": [
|
| 487 |
+
"imgColorTypeUndefined",
|
| 488 |
+
"mono",
|
| 489 |
+
"gray",
|
| 490 |
+
"color",
|
| 491 |
+
"trans"
|
| 492 |
+
],
|
| 493 |
+
"enumDescriptions": [
|
| 494 |
+
"No image color type specified.",
|
| 495 |
+
"Black and white images only.",
|
| 496 |
+
"Grayscale images only.",
|
| 497 |
+
"Color images only.",
|
| 498 |
+
"Images with transparent background"
|
| 499 |
+
],
|
| 500 |
+
"location": "query",
|
| 501 |
+
"type": "string"
|
| 502 |
+
},
|
| 503 |
+
"imgDominantColor": {
|
| 504 |
+
"description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`",
|
| 505 |
+
"enum": [
|
| 506 |
+
"imgDominantColorUndefined",
|
| 507 |
+
"black",
|
| 508 |
+
"blue",
|
| 509 |
+
"brown",
|
| 510 |
+
"gray",
|
| 511 |
+
"green",
|
| 512 |
+
"orange",
|
| 513 |
+
"pink",
|
| 514 |
+
"purple",
|
| 515 |
+
"red",
|
| 516 |
+
"teal",
|
| 517 |
+
"white",
|
| 518 |
+
"yellow"
|
| 519 |
+
],
|
| 520 |
+
"enumDescriptions": [
|
| 521 |
+
"No dominant color specified.",
|
| 522 |
+
"Predominantly black images only.",
|
| 523 |
+
"Predominantly blue images only.",
|
| 524 |
+
"Predominantly brown images only.",
|
| 525 |
+
"Predominantly gray images only.",
|
| 526 |
+
"Predominantly green images only.",
|
| 527 |
+
"Predominantly orange images only.",
|
| 528 |
+
"Predominantly pink images only.",
|
| 529 |
+
"Predominantly purple images only.",
|
| 530 |
+
"Predominantly red images only.",
|
| 531 |
+
"Predominantly teal images only.",
|
| 532 |
+
"Predominantly white images only.",
|
| 533 |
+
"Predominantly yellow images only."
|
| 534 |
+
],
|
| 535 |
+
"location": "query",
|
| 536 |
+
"type": "string"
|
| 537 |
+
},
|
| 538 |
+
"imgSize": {
|
| 539 |
+
"description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`",
|
| 540 |
+
"enum": [
|
| 541 |
+
"imgSizeUndefined",
|
| 542 |
+
"HUGE",
|
| 543 |
+
"ICON",
|
| 544 |
+
"LARGE",
|
| 545 |
+
"MEDIUM",
|
| 546 |
+
"SMALL",
|
| 547 |
+
"XLARGE",
|
| 548 |
+
"XXLARGE"
|
| 549 |
+
],
|
| 550 |
+
"enumDescriptions": [
|
| 551 |
+
"No image size specified.",
|
| 552 |
+
"Only the largest possible images.",
|
| 553 |
+
"Only very small icon-sized images.",
|
| 554 |
+
"Only large images.",
|
| 555 |
+
"Only medium images.",
|
| 556 |
+
"Only small images.",
|
| 557 |
+
"Only very large images.",
|
| 558 |
+
"Only extremely large images."
|
| 559 |
+
],
|
| 560 |
+
"location": "query",
|
| 561 |
+
"type": "string"
|
| 562 |
+
},
|
| 563 |
+
"imgType": {
|
| 564 |
+
"description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`",
|
| 565 |
+
"enum": [
|
| 566 |
+
"imgTypeUndefined",
|
| 567 |
+
"clipart",
|
| 568 |
+
"face",
|
| 569 |
+
"lineart",
|
| 570 |
+
"stock",
|
| 571 |
+
"photo",
|
| 572 |
+
"animated"
|
| 573 |
+
],
|
| 574 |
+
"enumDescriptions": [
|
| 575 |
+
"No image type specified.",
|
| 576 |
+
"Clipart-style images only.",
|
| 577 |
+
"Images of faces only.",
|
| 578 |
+
"Line art images only.",
|
| 579 |
+
"Stock images only.",
|
| 580 |
+
"Photo images only.",
|
| 581 |
+
"Animated images only."
|
| 582 |
+
],
|
| 583 |
+
"location": "query",
|
| 584 |
+
"type": "string"
|
| 585 |
+
},
|
| 586 |
+
"linkSite": {
|
| 587 |
+
"description": "Specifies that all search results should contain a link to a particular URL.",
|
| 588 |
+
"location": "query",
|
| 589 |
+
"type": "string"
|
| 590 |
+
},
|
| 591 |
+
"lowRange": {
|
| 592 |
+
"description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 593 |
+
"location": "query",
|
| 594 |
+
"type": "string"
|
| 595 |
+
},
|
| 596 |
+
"lr": {
|
| 597 |
+
"description": "Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)",
|
| 598 |
+
"location": "query",
|
| 599 |
+
"type": "string"
|
| 600 |
+
},
|
| 601 |
+
"num": {
|
| 602 |
+
"description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.",
|
| 603 |
+
"format": "int32",
|
| 604 |
+
"location": "query",
|
| 605 |
+
"type": "integer"
|
| 606 |
+
},
|
| 607 |
+
"orTerms": {
|
| 608 |
+
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.",
|
| 609 |
+
"location": "query",
|
| 610 |
+
"type": "string"
|
| 611 |
+
},
|
| 612 |
+
"q": {
|
| 613 |
+
"description": "Query",
|
| 614 |
+
"location": "query",
|
| 615 |
+
"type": "string"
|
| 616 |
+
},
|
| 617 |
+
"relatedSite": {
|
| 618 |
+
"deprecated": true,
|
| 619 |
+
"description": "Deprecated.",
|
| 620 |
+
"location": "query",
|
| 621 |
+
"type": "string"
|
| 622 |
+
},
|
| 623 |
+
"rights": {
|
| 624 |
+
"description": "Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).",
|
| 625 |
+
"location": "query",
|
| 626 |
+
"type": "string"
|
| 627 |
+
},
|
| 628 |
+
"safe": {
|
| 629 |
+
"description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)",
|
| 630 |
+
"enum": [
|
| 631 |
+
"safeUndefined",
|
| 632 |
+
"active",
|
| 633 |
+
"high",
|
| 634 |
+
"medium",
|
| 635 |
+
"off"
|
| 636 |
+
],
|
| 637 |
+
"enumDeprecated": [
|
| 638 |
+
false,
|
| 639 |
+
false,
|
| 640 |
+
true,
|
| 641 |
+
true,
|
| 642 |
+
false
|
| 643 |
+
],
|
| 644 |
+
"enumDescriptions": [
|
| 645 |
+
"SafeSearch mode unspecified. (Falls back to engine's configuration.)",
|
| 646 |
+
"Turn SafeSearch on.",
|
| 647 |
+
"Deprecated, equivalent to \"active\".",
|
| 648 |
+
"Deprecated, equivalent to \"active\".",
|
| 649 |
+
"Turn SafeSearch off."
|
| 650 |
+
],
|
| 651 |
+
"location": "query",
|
| 652 |
+
"type": "string"
|
| 653 |
+
},
|
| 654 |
+
"searchType": {
|
| 655 |
+
"description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.",
|
| 656 |
+
"enum": [
|
| 657 |
+
"searchTypeUndefined",
|
| 658 |
+
"image"
|
| 659 |
+
],
|
| 660 |
+
"enumDescriptions": [
|
| 661 |
+
"Search type unspecified (defaults to web search).",
|
| 662 |
+
"Image search."
|
| 663 |
+
],
|
| 664 |
+
"location": "query",
|
| 665 |
+
"type": "string"
|
| 666 |
+
},
|
| 667 |
+
"siteSearch": {
|
| 668 |
+
"description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).",
|
| 669 |
+
"location": "query",
|
| 670 |
+
"type": "string"
|
| 671 |
+
},
|
| 672 |
+
"siteSearchFilter": {
|
| 673 |
+
"description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include",
|
| 674 |
+
"enum": [
|
| 675 |
+
"siteSearchFilterUndefined",
|
| 676 |
+
"e",
|
| 677 |
+
"i"
|
| 678 |
+
],
|
| 679 |
+
"enumDescriptions": [
|
| 680 |
+
"Filter mode unspecified.",
|
| 681 |
+
"Exclude results from the listed sites.",
|
| 682 |
+
"Include only results from the listed sites."
|
| 683 |
+
],
|
| 684 |
+
"location": "query",
|
| 685 |
+
"type": "string"
|
| 686 |
+
},
|
| 687 |
+
"snippetLength": {
|
| 688 |
+
"description": "Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.",
|
| 689 |
+
"format": "int32",
|
| 690 |
+
"location": "query",
|
| 691 |
+
"type": "integer"
|
| 692 |
+
},
|
| 693 |
+
"sort": {
|
| 694 |
+
"description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).",
|
| 695 |
+
"location": "query",
|
| 696 |
+
"type": "string"
|
| 697 |
+
},
|
| 698 |
+
"start": {
|
| 699 |
+
"description": "The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.",
|
| 700 |
+
"format": "uint32",
|
| 701 |
+
"location": "query",
|
| 702 |
+
"type": "integer"
|
| 703 |
+
}
|
| 704 |
+
},
|
| 705 |
+
"path": "customsearch/v1/siterestrict",
|
| 706 |
+
"response": {
|
| 707 |
+
"$ref": "Search"
|
| 708 |
+
}
|
| 709 |
+
}
|
| 710 |
+
}
|
| 711 |
+
}
|
| 712 |
+
}
|
| 713 |
+
}
|
| 714 |
+
},
|
| 715 |
+
"revision": "20240821",
|
| 716 |
+
"rootUrl": "https://customsearch.googleapis.com/",
|
| 717 |
+
"schemas": {
|
| 718 |
+
"Promotion": {
|
| 719 |
+
"description": "Promotion result.",
|
| 720 |
+
"id": "Promotion",
|
| 721 |
+
"properties": {
|
| 722 |
+
"bodyLines": {
|
| 723 |
+
"description": "An array of block objects for this promotion.",
|
| 724 |
+
"items": {
|
| 725 |
+
"description": "Block object belonging to a promotion.",
|
| 726 |
+
"properties": {
|
| 727 |
+
"htmlTitle": {
|
| 728 |
+
"description": "The block object's text in HTML, if it has text.",
|
| 729 |
+
"type": "string"
|
| 730 |
+
},
|
| 731 |
+
"link": {
|
| 732 |
+
"description": "The anchor text of the block object's link, if it has a link.",
|
| 733 |
+
"type": "string"
|
| 734 |
+
},
|
| 735 |
+
"title": {
|
| 736 |
+
"description": "The block object's text, if it has text.",
|
| 737 |
+
"type": "string"
|
| 738 |
+
},
|
| 739 |
+
"url": {
|
| 740 |
+
"description": "The URL of the block object's link, if it has one.",
|
| 741 |
+
"type": "string"
|
| 742 |
+
}
|
| 743 |
+
},
|
| 744 |
+
"type": "object"
|
| 745 |
+
},
|
| 746 |
+
"type": "array"
|
| 747 |
+
},
|
| 748 |
+
"displayLink": {
|
| 749 |
+
"description": "An abridged version of this search's result URL, e.g. www.example.com.",
|
| 750 |
+
"type": "string"
|
| 751 |
+
},
|
| 752 |
+
"htmlTitle": {
|
| 753 |
+
"description": "The title of the promotion, in HTML.",
|
| 754 |
+
"type": "string"
|
| 755 |
+
},
|
| 756 |
+
"image": {
|
| 757 |
+
"description": "Image belonging to a promotion.",
|
| 758 |
+
"properties": {
|
| 759 |
+
"height": {
|
| 760 |
+
"description": "Image height in pixels.",
|
| 761 |
+
"format": "int32",
|
| 762 |
+
"type": "integer"
|
| 763 |
+
},
|
| 764 |
+
"source": {
|
| 765 |
+
"description": "URL of the image for this promotion link.",
|
| 766 |
+
"type": "string"
|
| 767 |
+
},
|
| 768 |
+
"width": {
|
| 769 |
+
"description": "Image width in pixels.",
|
| 770 |
+
"format": "int32",
|
| 771 |
+
"type": "integer"
|
| 772 |
+
}
|
| 773 |
+
},
|
| 774 |
+
"type": "object"
|
| 775 |
+
},
|
| 776 |
+
"link": {
|
| 777 |
+
"description": "The URL of the promotion.",
|
| 778 |
+
"type": "string"
|
| 779 |
+
},
|
| 780 |
+
"title": {
|
| 781 |
+
"description": "The title of the promotion.",
|
| 782 |
+
"type": "string"
|
| 783 |
+
}
|
| 784 |
+
},
|
| 785 |
+
"type": "object"
|
| 786 |
+
},
|
| 787 |
+
"Result": {
|
| 788 |
+
"description": "A custom search result.",
|
| 789 |
+
"id": "Result",
|
| 790 |
+
"properties": {
|
| 791 |
+
"cacheId": {
|
| 792 |
+
"description": "Indicates the ID of Google's cached version of the search result.",
|
| 793 |
+
"type": "string"
|
| 794 |
+
},
|
| 795 |
+
"displayLink": {
|
| 796 |
+
"description": "An abridged version of this search result\u2019s URL, e.g. www.example.com.",
|
| 797 |
+
"type": "string"
|
| 798 |
+
},
|
| 799 |
+
"fileFormat": {
|
| 800 |
+
"description": "The file format of the search result.",
|
| 801 |
+
"type": "string"
|
| 802 |
+
},
|
| 803 |
+
"formattedUrl": {
|
| 804 |
+
"description": "The URL displayed after the snippet for each search result.",
|
| 805 |
+
"type": "string"
|
| 806 |
+
},
|
| 807 |
+
"htmlFormattedUrl": {
|
| 808 |
+
"description": "The HTML-formatted URL displayed after the snippet for each search result.",
|
| 809 |
+
"type": "string"
|
| 810 |
+
},
|
| 811 |
+
"htmlSnippet": {
|
| 812 |
+
"description": "The snippet of the search result, in HTML.",
|
| 813 |
+
"type": "string"
|
| 814 |
+
},
|
| 815 |
+
"htmlTitle": {
|
| 816 |
+
"description": "The title of the search result, in HTML.",
|
| 817 |
+
"type": "string"
|
| 818 |
+
},
|
| 819 |
+
"image": {
|
| 820 |
+
"description": "Image belonging to a custom search result.",
|
| 821 |
+
"properties": {
|
| 822 |
+
"byteSize": {
|
| 823 |
+
"description": "The size of the image, in bytes.",
|
| 824 |
+
"format": "int32",
|
| 825 |
+
"type": "integer"
|
| 826 |
+
},
|
| 827 |
+
"contextLink": {
|
| 828 |
+
"description": "A URL pointing to the webpage hosting the image.",
|
| 829 |
+
"type": "string"
|
| 830 |
+
},
|
| 831 |
+
"height": {
|
| 832 |
+
"description": "The height of the image, in pixels.",
|
| 833 |
+
"format": "int32",
|
| 834 |
+
"type": "integer"
|
| 835 |
+
},
|
| 836 |
+
"thumbnailHeight": {
|
| 837 |
+
"description": "The height of the thumbnail image, in pixels.",
|
| 838 |
+
"format": "int32",
|
| 839 |
+
"type": "integer"
|
| 840 |
+
},
|
| 841 |
+
"thumbnailLink": {
|
| 842 |
+
"description": "A URL to the thumbnail image.",
|
| 843 |
+
"type": "string"
|
| 844 |
+
},
|
| 845 |
+
"thumbnailWidth": {
|
| 846 |
+
"description": "The width of the thumbnail image, in pixels.",
|
| 847 |
+
"format": "int32",
|
| 848 |
+
"type": "integer"
|
| 849 |
+
},
|
| 850 |
+
"width": {
|
| 851 |
+
"description": "The width of the image, in pixels.",
|
| 852 |
+
"format": "int32",
|
| 853 |
+
"type": "integer"
|
| 854 |
+
}
|
| 855 |
+
},
|
| 856 |
+
"type": "object"
|
| 857 |
+
},
|
| 858 |
+
"kind": {
|
| 859 |
+
"description": "A unique identifier for the type of current object. For this API, it is `customsearch#result.`",
|
| 860 |
+
"type": "string"
|
| 861 |
+
},
|
| 862 |
+
"labels": {
|
| 863 |
+
"description": "Encapsulates all information about refinement labels.",
|
| 864 |
+
"items": {
|
| 865 |
+
"description": "Refinement label associated with a custom search result.",
|
| 866 |
+
"properties": {
|
| 867 |
+
"displayName": {
|
| 868 |
+
"description": "The display name of a refinement label. This is the name you should display in your user interface.",
|
| 869 |
+
"type": "string"
|
| 870 |
+
},
|
| 871 |
+
"label_with_op": {
|
| 872 |
+
"description": "Refinement label and the associated refinement operation.",
|
| 873 |
+
"type": "string"
|
| 874 |
+
},
|
| 875 |
+
"name": {
|
| 876 |
+
"description": "The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.",
|
| 877 |
+
"type": "string"
|
| 878 |
+
}
|
| 879 |
+
},
|
| 880 |
+
"type": "object"
|
| 881 |
+
},
|
| 882 |
+
"type": "array"
|
| 883 |
+
},
|
| 884 |
+
"link": {
|
| 885 |
+
"description": "The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.",
|
| 886 |
+
"type": "string"
|
| 887 |
+
},
|
| 888 |
+
"mime": {
|
| 889 |
+
"description": "The MIME type of the search result.",
|
| 890 |
+
"type": "string"
|
| 891 |
+
},
|
| 892 |
+
"pagemap": {
|
| 893 |
+
"additionalProperties": {
|
| 894 |
+
"description": "Properties of the object.",
|
| 895 |
+
"type": "any"
|
| 896 |
+
},
|
| 897 |
+
"description": "Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.",
|
| 898 |
+
"type": "object"
|
| 899 |
+
},
|
| 900 |
+
"snippet": {
|
| 901 |
+
"description": "The snippet of the search result, in plain text.",
|
| 902 |
+
"type": "string"
|
| 903 |
+
},
|
| 904 |
+
"title": {
|
| 905 |
+
"description": "The title of the search result, in plain text.",
|
| 906 |
+
"type": "string"
|
| 907 |
+
}
|
| 908 |
+
},
|
| 909 |
+
"type": "object"
|
| 910 |
+
},
|
| 911 |
+
"Search": {
|
| 912 |
+
"description": "Response to a custom search request.",
|
| 913 |
+
"id": "Search",
|
| 914 |
+
"properties": {
|
| 915 |
+
"context": {
|
| 916 |
+
"additionalProperties": {
|
| 917 |
+
"description": "Properties of the object.",
|
| 918 |
+
"type": "any"
|
| 919 |
+
},
|
| 920 |
+
"description": "Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.",
|
| 921 |
+
"type": "object"
|
| 922 |
+
},
|
| 923 |
+
"items": {
|
| 924 |
+
"description": "The current set of custom search results.",
|
| 925 |
+
"items": {
|
| 926 |
+
"$ref": "Result"
|
| 927 |
+
},
|
| 928 |
+
"type": "array"
|
| 929 |
+
},
|
| 930 |
+
"kind": {
|
| 931 |
+
"description": "Unique identifier for the type of current object. For this API, it is customsearch#search.",
|
| 932 |
+
"type": "string"
|
| 933 |
+
},
|
| 934 |
+
"promotions": {
|
| 935 |
+
"description": "The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.",
|
| 936 |
+
"items": {
|
| 937 |
+
"$ref": "Promotion"
|
| 938 |
+
},
|
| 939 |
+
"type": "array"
|
| 940 |
+
},
|
| 941 |
+
"queries": {
|
| 942 |
+
"description": "Query metadata for the previous, current, and next pages of results.",
|
| 943 |
+
"properties": {
|
| 944 |
+
"nextPage": {
|
| 945 |
+
"description": "Metadata representing the next page of results, if applicable.",
|
| 946 |
+
"items": {
|
| 947 |
+
"description": "Custom search request metadata.",
|
| 948 |
+
"properties": {
|
| 949 |
+
"count": {
|
| 950 |
+
"description": "Number of search results returned in this set.",
|
| 951 |
+
"format": "int32",
|
| 952 |
+
"type": "integer"
|
| 953 |
+
},
|
| 954 |
+
"cr": {
|
| 955 |
+
"description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.",
|
| 956 |
+
"type": "string"
|
| 957 |
+
},
|
| 958 |
+
"cx": {
|
| 959 |
+
"description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.",
|
| 960 |
+
"type": "string"
|
| 961 |
+
},
|
| 962 |
+
"dateRestrict": {
|
| 963 |
+
"description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.",
|
| 964 |
+
"type": "string"
|
| 965 |
+
},
|
| 966 |
+
"disableCnTwTranslation": {
|
| 967 |
+
"description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled",
|
| 968 |
+
"type": "string"
|
| 969 |
+
},
|
| 970 |
+
"exactTerms": {
|
| 971 |
+
"description": "Identifies a phrase that all documents in the search results must contain.",
|
| 972 |
+
"type": "string"
|
| 973 |
+
},
|
| 974 |
+
"excludeTerms": {
|
| 975 |
+
"description": "Identifies a word or phrase that should not appear in any documents in the search results.",
|
| 976 |
+
"type": "string"
|
| 977 |
+
},
|
| 978 |
+
"fileType": {
|
| 979 |
+
"description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).",
|
| 980 |
+
"type": "string"
|
| 981 |
+
},
|
| 982 |
+
"filter": {
|
| 983 |
+
"description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.",
|
| 984 |
+
"type": "string"
|
| 985 |
+
},
|
| 986 |
+
"gl": {
|
| 987 |
+
"description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.",
|
| 988 |
+
"type": "string"
|
| 989 |
+
},
|
| 990 |
+
"googleHost": {
|
| 991 |
+
"description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.",
|
| 992 |
+
"type": "string"
|
| 993 |
+
},
|
| 994 |
+
"highRange": {
|
| 995 |
+
"description": "Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 996 |
+
"type": "string"
|
| 997 |
+
},
|
| 998 |
+
"hl": {
|
| 999 |
+
"description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.",
|
| 1000 |
+
"type": "string"
|
| 1001 |
+
},
|
| 1002 |
+
"hq": {
|
| 1003 |
+
"description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.",
|
| 1004 |
+
"type": "string"
|
| 1005 |
+
},
|
| 1006 |
+
"imgColorType": {
|
| 1007 |
+
"description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)",
|
| 1008 |
+
"type": "string"
|
| 1009 |
+
},
|
| 1010 |
+
"imgDominantColor": {
|
| 1011 |
+
"description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`",
|
| 1012 |
+
"type": "string"
|
| 1013 |
+
},
|
| 1014 |
+
"imgSize": {
|
| 1015 |
+
"description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)",
|
| 1016 |
+
"type": "string"
|
| 1017 |
+
},
|
| 1018 |
+
"imgType": {
|
| 1019 |
+
"description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)",
|
| 1020 |
+
"type": "string"
|
| 1021 |
+
},
|
| 1022 |
+
"inputEncoding": {
|
| 1023 |
+
"description": "The character encoding supported for search requests.",
|
| 1024 |
+
"type": "string"
|
| 1025 |
+
},
|
| 1026 |
+
"language": {
|
| 1027 |
+
"description": "The language of the search results.",
|
| 1028 |
+
"type": "string"
|
| 1029 |
+
},
|
| 1030 |
+
"linkSite": {
|
| 1031 |
+
"description": "Specifies that all results should contain a link to a specific URL.",
|
| 1032 |
+
"type": "string"
|
| 1033 |
+
},
|
| 1034 |
+
"lowRange": {
|
| 1035 |
+
"description": "Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 1036 |
+
"type": "string"
|
| 1037 |
+
},
|
| 1038 |
+
"orTerms": {
|
| 1039 |
+
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.",
|
| 1040 |
+
"type": "string"
|
| 1041 |
+
},
|
| 1042 |
+
"outputEncoding": {
|
| 1043 |
+
"description": "The character encoding supported for search results.",
|
| 1044 |
+
"type": "string"
|
| 1045 |
+
},
|
| 1046 |
+
"relatedSite": {
|
| 1047 |
+
"description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.",
|
| 1048 |
+
"type": "string"
|
| 1049 |
+
},
|
| 1050 |
+
"rights": {
|
| 1051 |
+
"description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`",
|
| 1052 |
+
"type": "string"
|
| 1053 |
+
},
|
| 1054 |
+
"safe": {
|
| 1055 |
+
"description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch",
|
| 1056 |
+
"type": "string"
|
| 1057 |
+
},
|
| 1058 |
+
"searchTerms": {
|
| 1059 |
+
"description": "The search terms entered by the user.",
|
| 1060 |
+
"type": "string"
|
| 1061 |
+
},
|
| 1062 |
+
"searchType": {
|
| 1063 |
+
"description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.",
|
| 1064 |
+
"type": "string"
|
| 1065 |
+
},
|
| 1066 |
+
"siteSearch": {
|
| 1067 |
+
"description": "Restricts results to URLs from a specified site.",
|
| 1068 |
+
"type": "string"
|
| 1069 |
+
},
|
| 1070 |
+
"siteSearchFilter": {
|
| 1071 |
+
"description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site",
|
| 1072 |
+
"type": "string"
|
| 1073 |
+
},
|
| 1074 |
+
"sort": {
|
| 1075 |
+
"description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.",
|
| 1076 |
+
"type": "string"
|
| 1077 |
+
},
|
| 1078 |
+
"startIndex": {
|
| 1079 |
+
"description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.",
|
| 1080 |
+
"format": "int32",
|
| 1081 |
+
"type": "integer"
|
| 1082 |
+
},
|
| 1083 |
+
"startPage": {
|
| 1084 |
+
"description": "The page number of this set of results, where the page length is set by the `count` property.",
|
| 1085 |
+
"format": "int32",
|
| 1086 |
+
"type": "integer"
|
| 1087 |
+
},
|
| 1088 |
+
"title": {
|
| 1089 |
+
"description": "A description of the query.",
|
| 1090 |
+
"type": "string"
|
| 1091 |
+
},
|
| 1092 |
+
"totalResults": {
|
| 1093 |
+
"description": "Estimated number of total search results. May not be accurate.",
|
| 1094 |
+
"format": "int64",
|
| 1095 |
+
"type": "string"
|
| 1096 |
+
}
|
| 1097 |
+
},
|
| 1098 |
+
"type": "object"
|
| 1099 |
+
},
|
| 1100 |
+
"type": "array"
|
| 1101 |
+
},
|
| 1102 |
+
"previousPage": {
|
| 1103 |
+
"description": "Metadata representing the previous page of results, if applicable.",
|
| 1104 |
+
"items": {
|
| 1105 |
+
"description": "Custom search request metadata.",
|
| 1106 |
+
"properties": {
|
| 1107 |
+
"count": {
|
| 1108 |
+
"description": "Number of search results returned in this set.",
|
| 1109 |
+
"format": "int32",
|
| 1110 |
+
"type": "integer"
|
| 1111 |
+
},
|
| 1112 |
+
"cr": {
|
| 1113 |
+
"description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.",
|
| 1114 |
+
"type": "string"
|
| 1115 |
+
},
|
| 1116 |
+
"cx": {
|
| 1117 |
+
"description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.",
|
| 1118 |
+
"type": "string"
|
| 1119 |
+
},
|
| 1120 |
+
"dateRestrict": {
|
| 1121 |
+
"description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.",
|
| 1122 |
+
"type": "string"
|
| 1123 |
+
},
|
| 1124 |
+
"disableCnTwTranslation": {
|
| 1125 |
+
"description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled",
|
| 1126 |
+
"type": "string"
|
| 1127 |
+
},
|
| 1128 |
+
"exactTerms": {
|
| 1129 |
+
"description": "Identifies a phrase that all documents in the search results must contain.",
|
| 1130 |
+
"type": "string"
|
| 1131 |
+
},
|
| 1132 |
+
"excludeTerms": {
|
| 1133 |
+
"description": "Identifies a word or phrase that should not appear in any documents in the search results.",
|
| 1134 |
+
"type": "string"
|
| 1135 |
+
},
|
| 1136 |
+
"fileType": {
|
| 1137 |
+
"description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).",
|
| 1138 |
+
"type": "string"
|
| 1139 |
+
},
|
| 1140 |
+
"filter": {
|
| 1141 |
+
"description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.",
|
| 1142 |
+
"type": "string"
|
| 1143 |
+
},
|
| 1144 |
+
"gl": {
|
| 1145 |
+
"description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.",
|
| 1146 |
+
"type": "string"
|
| 1147 |
+
},
|
| 1148 |
+
"googleHost": {
|
| 1149 |
+
"description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.",
|
| 1150 |
+
"type": "string"
|
| 1151 |
+
},
|
| 1152 |
+
"highRange": {
|
| 1153 |
+
"description": "Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 1154 |
+
"type": "string"
|
| 1155 |
+
},
|
| 1156 |
+
"hl": {
|
| 1157 |
+
"description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.",
|
| 1158 |
+
"type": "string"
|
| 1159 |
+
},
|
| 1160 |
+
"hq": {
|
| 1161 |
+
"description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.",
|
| 1162 |
+
"type": "string"
|
| 1163 |
+
},
|
| 1164 |
+
"imgColorType": {
|
| 1165 |
+
"description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)",
|
| 1166 |
+
"type": "string"
|
| 1167 |
+
},
|
| 1168 |
+
"imgDominantColor": {
|
| 1169 |
+
"description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`",
|
| 1170 |
+
"type": "string"
|
| 1171 |
+
},
|
| 1172 |
+
"imgSize": {
|
| 1173 |
+
"description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)",
|
| 1174 |
+
"type": "string"
|
| 1175 |
+
},
|
| 1176 |
+
"imgType": {
|
| 1177 |
+
"description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)",
|
| 1178 |
+
"type": "string"
|
| 1179 |
+
},
|
| 1180 |
+
"inputEncoding": {
|
| 1181 |
+
"description": "The character encoding supported for search requests.",
|
| 1182 |
+
"type": "string"
|
| 1183 |
+
},
|
| 1184 |
+
"language": {
|
| 1185 |
+
"description": "The language of the search results.",
|
| 1186 |
+
"type": "string"
|
| 1187 |
+
},
|
| 1188 |
+
"linkSite": {
|
| 1189 |
+
"description": "Specifies that all results should contain a link to a specific URL.",
|
| 1190 |
+
"type": "string"
|
| 1191 |
+
},
|
| 1192 |
+
"lowRange": {
|
| 1193 |
+
"description": "Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 1194 |
+
"type": "string"
|
| 1195 |
+
},
|
| 1196 |
+
"orTerms": {
|
| 1197 |
+
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.",
|
| 1198 |
+
"type": "string"
|
| 1199 |
+
},
|
| 1200 |
+
"outputEncoding": {
|
| 1201 |
+
"description": "The character encoding supported for search results.",
|
| 1202 |
+
"type": "string"
|
| 1203 |
+
},
|
| 1204 |
+
"relatedSite": {
|
| 1205 |
+
"description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.",
|
| 1206 |
+
"type": "string"
|
| 1207 |
+
},
|
| 1208 |
+
"rights": {
|
| 1209 |
+
"description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`",
|
| 1210 |
+
"type": "string"
|
| 1211 |
+
},
|
| 1212 |
+
"safe": {
|
| 1213 |
+
"description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch",
|
| 1214 |
+
"type": "string"
|
| 1215 |
+
},
|
| 1216 |
+
"searchTerms": {
|
| 1217 |
+
"description": "The search terms entered by the user.",
|
| 1218 |
+
"type": "string"
|
| 1219 |
+
},
|
| 1220 |
+
"searchType": {
|
| 1221 |
+
"description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.",
|
| 1222 |
+
"type": "string"
|
| 1223 |
+
},
|
| 1224 |
+
"siteSearch": {
|
| 1225 |
+
"description": "Restricts results to URLs from a specified site.",
|
| 1226 |
+
"type": "string"
|
| 1227 |
+
},
|
| 1228 |
+
"siteSearchFilter": {
|
| 1229 |
+
"description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site",
|
| 1230 |
+
"type": "string"
|
| 1231 |
+
},
|
| 1232 |
+
"sort": {
|
| 1233 |
+
"description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.",
|
| 1234 |
+
"type": "string"
|
| 1235 |
+
},
|
| 1236 |
+
"startIndex": {
|
| 1237 |
+
"description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.",
|
| 1238 |
+
"format": "int32",
|
| 1239 |
+
"type": "integer"
|
| 1240 |
+
},
|
| 1241 |
+
"startPage": {
|
| 1242 |
+
"description": "The page number of this set of results, where the page length is set by the `count` property.",
|
| 1243 |
+
"format": "int32",
|
| 1244 |
+
"type": "integer"
|
| 1245 |
+
},
|
| 1246 |
+
"title": {
|
| 1247 |
+
"description": "A description of the query.",
|
| 1248 |
+
"type": "string"
|
| 1249 |
+
},
|
| 1250 |
+
"totalResults": {
|
| 1251 |
+
"description": "Estimated number of total search results. May not be accurate.",
|
| 1252 |
+
"format": "int64",
|
| 1253 |
+
"type": "string"
|
| 1254 |
+
}
|
| 1255 |
+
},
|
| 1256 |
+
"type": "object"
|
| 1257 |
+
},
|
| 1258 |
+
"type": "array"
|
| 1259 |
+
},
|
| 1260 |
+
"request": {
|
| 1261 |
+
"description": "Metadata representing the current request.",
|
| 1262 |
+
"items": {
|
| 1263 |
+
"description": "Custom search request metadata.",
|
| 1264 |
+
"properties": {
|
| 1265 |
+
"count": {
|
| 1266 |
+
"description": "Number of search results returned in this set.",
|
| 1267 |
+
"format": "int32",
|
| 1268 |
+
"type": "integer"
|
| 1269 |
+
},
|
| 1270 |
+
"cr": {
|
| 1271 |
+
"description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.",
|
| 1272 |
+
"type": "string"
|
| 1273 |
+
},
|
| 1274 |
+
"cx": {
|
| 1275 |
+
"description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.",
|
| 1276 |
+
"type": "string"
|
| 1277 |
+
},
|
| 1278 |
+
"dateRestrict": {
|
| 1279 |
+
"description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.",
|
| 1280 |
+
"type": "string"
|
| 1281 |
+
},
|
| 1282 |
+
"disableCnTwTranslation": {
|
| 1283 |
+
"description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled",
|
| 1284 |
+
"type": "string"
|
| 1285 |
+
},
|
| 1286 |
+
"exactTerms": {
|
| 1287 |
+
"description": "Identifies a phrase that all documents in the search results must contain.",
|
| 1288 |
+
"type": "string"
|
| 1289 |
+
},
|
| 1290 |
+
"excludeTerms": {
|
| 1291 |
+
"description": "Identifies a word or phrase that should not appear in any documents in the search results.",
|
| 1292 |
+
"type": "string"
|
| 1293 |
+
},
|
| 1294 |
+
"fileType": {
|
| 1295 |
+
"description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).",
|
| 1296 |
+
"type": "string"
|
| 1297 |
+
},
|
| 1298 |
+
"filter": {
|
| 1299 |
+
"description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.",
|
| 1300 |
+
"type": "string"
|
| 1301 |
+
},
|
| 1302 |
+
"gl": {
|
| 1303 |
+
"description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.",
|
| 1304 |
+
"type": "string"
|
| 1305 |
+
},
|
| 1306 |
+
"googleHost": {
|
| 1307 |
+
"description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.",
|
| 1308 |
+
"type": "string"
|
| 1309 |
+
},
|
| 1310 |
+
"highRange": {
|
| 1311 |
+
"description": "Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 1312 |
+
"type": "string"
|
| 1313 |
+
},
|
| 1314 |
+
"hl": {
|
| 1315 |
+
"description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.",
|
| 1316 |
+
"type": "string"
|
| 1317 |
+
},
|
| 1318 |
+
"hq": {
|
| 1319 |
+
"description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.",
|
| 1320 |
+
"type": "string"
|
| 1321 |
+
},
|
| 1322 |
+
"imgColorType": {
|
| 1323 |
+
"description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)",
|
| 1324 |
+
"type": "string"
|
| 1325 |
+
},
|
| 1326 |
+
"imgDominantColor": {
|
| 1327 |
+
"description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`",
|
| 1328 |
+
"type": "string"
|
| 1329 |
+
},
|
| 1330 |
+
"imgSize": {
|
| 1331 |
+
"description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)",
|
| 1332 |
+
"type": "string"
|
| 1333 |
+
},
|
| 1334 |
+
"imgType": {
|
| 1335 |
+
"description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)",
|
| 1336 |
+
"type": "string"
|
| 1337 |
+
},
|
| 1338 |
+
"inputEncoding": {
|
| 1339 |
+
"description": "The character encoding supported for search requests.",
|
| 1340 |
+
"type": "string"
|
| 1341 |
+
},
|
| 1342 |
+
"language": {
|
| 1343 |
+
"description": "The language of the search results.",
|
| 1344 |
+
"type": "string"
|
| 1345 |
+
},
|
| 1346 |
+
"linkSite": {
|
| 1347 |
+
"description": "Specifies that all results should contain a link to a specific URL.",
|
| 1348 |
+
"type": "string"
|
| 1349 |
+
},
|
| 1350 |
+
"lowRange": {
|
| 1351 |
+
"description": "Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.",
|
| 1352 |
+
"type": "string"
|
| 1353 |
+
},
|
| 1354 |
+
"orTerms": {
|
| 1355 |
+
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.",
|
| 1356 |
+
"type": "string"
|
| 1357 |
+
},
|
| 1358 |
+
"outputEncoding": {
|
| 1359 |
+
"description": "The character encoding supported for search results.",
|
| 1360 |
+
"type": "string"
|
| 1361 |
+
},
|
| 1362 |
+
"relatedSite": {
|
| 1363 |
+
"description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.",
|
| 1364 |
+
"type": "string"
|
| 1365 |
+
},
|
| 1366 |
+
"rights": {
|
| 1367 |
+
"description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`",
|
| 1368 |
+
"type": "string"
|
| 1369 |
+
},
|
| 1370 |
+
"safe": {
|
| 1371 |
+
"description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch",
|
| 1372 |
+
"type": "string"
|
| 1373 |
+
},
|
| 1374 |
+
"searchTerms": {
|
| 1375 |
+
"description": "The search terms entered by the user.",
|
| 1376 |
+
"type": "string"
|
| 1377 |
+
},
|
| 1378 |
+
"searchType": {
|
| 1379 |
+
"description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.",
|
| 1380 |
+
"type": "string"
|
| 1381 |
+
},
|
| 1382 |
+
"siteSearch": {
|
| 1383 |
+
"description": "Restricts results to URLs from a specified site.",
|
| 1384 |
+
"type": "string"
|
| 1385 |
+
},
|
| 1386 |
+
"siteSearchFilter": {
|
| 1387 |
+
"description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site",
|
| 1388 |
+
"type": "string"
|
| 1389 |
+
},
|
| 1390 |
+
"sort": {
|
| 1391 |
+
"description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.",
|
| 1392 |
+
"type": "string"
|
| 1393 |
+
},
|
| 1394 |
+
"startIndex": {
|
| 1395 |
+
"description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.",
|
| 1396 |
+
"format": "int32",
|
| 1397 |
+
"type": "integer"
|
| 1398 |
+
},
|
| 1399 |
+
"startPage": {
|
| 1400 |
+
"description": "The page number of this set of results, where the page length is set by the `count` property.",
|
| 1401 |
+
"format": "int32",
|
| 1402 |
+
"type": "integer"
|
| 1403 |
+
},
|
| 1404 |
+
"title": {
|
| 1405 |
+
"description": "A description of the query.",
|
| 1406 |
+
"type": "string"
|
| 1407 |
+
},
|
| 1408 |
+
"totalResults": {
|
| 1409 |
+
"description": "Estimated number of total search results. May not be accurate.",
|
| 1410 |
+
"format": "int64",
|
| 1411 |
+
"type": "string"
|
| 1412 |
+
}
|
| 1413 |
+
},
|
| 1414 |
+
"type": "object"
|
| 1415 |
+
},
|
| 1416 |
+
"type": "array"
|
| 1417 |
+
}
|
| 1418 |
+
},
|
| 1419 |
+
"type": "object"
|
| 1420 |
+
},
|
| 1421 |
+
"searchInformation": {
|
| 1422 |
+
"description": "Metadata about a search operation.",
|
| 1423 |
+
"properties": {
|
| 1424 |
+
"formattedSearchTime": {
|
| 1425 |
+
"description": "The time taken for the server to return search results, formatted according to locale style.",
|
| 1426 |
+
"type": "string"
|
| 1427 |
+
},
|
| 1428 |
+
"formattedTotalResults": {
|
| 1429 |
+
"description": "The total number of search results, formatted according to locale style.",
|
| 1430 |
+
"type": "string"
|
| 1431 |
+
},
|
| 1432 |
+
"searchTime": {
|
| 1433 |
+
"description": "The time taken for the server to return search results.",
|
| 1434 |
+
"format": "double",
|
| 1435 |
+
"type": "number"
|
| 1436 |
+
},
|
| 1437 |
+
"totalResults": {
|
| 1438 |
+
"description": "The total number of search results returned by the query.",
|
| 1439 |
+
"type": "string"
|
| 1440 |
+
}
|
| 1441 |
+
},
|
| 1442 |
+
"type": "object"
|
| 1443 |
+
},
|
| 1444 |
+
"spelling": {
|
| 1445 |
+
"description": "Spell correction information for a query.",
|
| 1446 |
+
"properties": {
|
| 1447 |
+
"correctedQuery": {
|
| 1448 |
+
"description": "The corrected query.",
|
| 1449 |
+
"type": "string"
|
| 1450 |
+
},
|
| 1451 |
+
"htmlCorrectedQuery": {
|
| 1452 |
+
"description": "The corrected query, formatted in HTML.",
|
| 1453 |
+
"type": "string"
|
| 1454 |
+
}
|
| 1455 |
+
},
|
| 1456 |
+
"type": "object"
|
| 1457 |
+
},
|
| 1458 |
+
"url": {
|
| 1459 |
+
"description": "OpenSearch template and URL.",
|
| 1460 |
+
"properties": {
|
| 1461 |
+
"template": {
|
| 1462 |
+
"description": "The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API.",
|
| 1463 |
+
"type": "string"
|
| 1464 |
+
},
|
| 1465 |
+
"type": {
|
| 1466 |
+
"description": "The MIME type of the OpenSearch URL template for the Custom Search JSON API.",
|
| 1467 |
+
"type": "string"
|
| 1468 |
+
}
|
| 1469 |
+
},
|
| 1470 |
+
"type": "object"
|
| 1471 |
+
}
|
| 1472 |
+
},
|
| 1473 |
+
"type": "object"
|
| 1474 |
+
}
|
| 1475 |
+
},
|
| 1476 |
+
"servicePath": "",
|
| 1477 |
+
"title": "Custom Search API",
|
| 1478 |
+
"version": "v1",
|
| 1479 |
+
"version_module": true
|
| 1480 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/datacatalog.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json
ADDED
|
@@ -0,0 +1,729 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/dfatrafficking": {
|
| 6 |
+
"description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "/dfareporting/v3.5/",
|
| 12 |
+
"baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.5/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Dfareporting",
|
| 15 |
+
"description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "dfareporting:v3.5",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
|
| 26 |
+
"name": "dfareporting",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"media": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"upload": {
|
| 111 |
+
"description": "Inserts a new creative asset.",
|
| 112 |
+
"flatPath": "userprofiles/{userprofilesId}/creativeAssets/{creativeAssetsId}/creativeAssets",
|
| 113 |
+
"httpMethod": "POST",
|
| 114 |
+
"id": "dfareporting.media.upload",
|
| 115 |
+
"mediaUpload": {
|
| 116 |
+
"accept": [
|
| 117 |
+
"*/*"
|
| 118 |
+
],
|
| 119 |
+
"maxSize": "1073741824",
|
| 120 |
+
"protocols": {
|
| 121 |
+
"simple": {
|
| 122 |
+
"multipart": true,
|
| 123 |
+
"path": "/upload/dfareporting/v3.5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets"
|
| 124 |
+
}
|
| 125 |
+
}
|
| 126 |
+
},
|
| 127 |
+
"parameterOrder": [
|
| 128 |
+
"profileId",
|
| 129 |
+
"advertiserId"
|
| 130 |
+
],
|
| 131 |
+
"parameters": {
|
| 132 |
+
"advertiserId": {
|
| 133 |
+
"description": "Advertiser ID of this creative. This is a required field.",
|
| 134 |
+
"format": "int64",
|
| 135 |
+
"location": "path",
|
| 136 |
+
"pattern": "^[^/]+$",
|
| 137 |
+
"required": true,
|
| 138 |
+
"type": "string"
|
| 139 |
+
},
|
| 140 |
+
"profileId": {
|
| 141 |
+
"description": "User profile ID associated with this request.",
|
| 142 |
+
"format": "int64",
|
| 143 |
+
"location": "path",
|
| 144 |
+
"pattern": "^[^/]+$",
|
| 145 |
+
"required": true,
|
| 146 |
+
"type": "string"
|
| 147 |
+
}
|
| 148 |
+
},
|
| 149 |
+
"path": "userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets",
|
| 150 |
+
"request": {
|
| 151 |
+
"$ref": "CreativeAssetMetadata"
|
| 152 |
+
},
|
| 153 |
+
"response": {
|
| 154 |
+
"$ref": "CreativeAssetMetadata"
|
| 155 |
+
},
|
| 156 |
+
"scopes": [
|
| 157 |
+
"https://www.googleapis.com/auth/dfatrafficking"
|
| 158 |
+
],
|
| 159 |
+
"supportsMediaUpload": true
|
| 160 |
+
}
|
| 161 |
+
}
|
| 162 |
+
}
|
| 163 |
+
},
|
| 164 |
+
"revision": "20240821",
|
| 165 |
+
"rootUrl": "https://dfareporting.googleapis.com/",
|
| 166 |
+
"schemas": {
|
| 167 |
+
"ClickTag": {
|
| 168 |
+
"description": "Creative Click Tag.",
|
| 169 |
+
"id": "ClickTag",
|
| 170 |
+
"properties": {
|
| 171 |
+
"clickThroughUrl": {
|
| 172 |
+
"$ref": "CreativeClickThroughUrl",
|
| 173 |
+
"description": "Parameter value for the specified click tag. This field contains a click-through url."
|
| 174 |
+
},
|
| 175 |
+
"eventName": {
|
| 176 |
+
"description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
|
| 177 |
+
"type": "string"
|
| 178 |
+
},
|
| 179 |
+
"name": {
|
| 180 |
+
"description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
|
| 181 |
+
"type": "string"
|
| 182 |
+
}
|
| 183 |
+
},
|
| 184 |
+
"type": "object"
|
| 185 |
+
},
|
| 186 |
+
"CreativeAssetId": {
|
| 187 |
+
"description": "Creative Asset ID.",
|
| 188 |
+
"id": "CreativeAssetId",
|
| 189 |
+
"properties": {
|
| 190 |
+
"name": {
|
| 191 |
+
"description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
|
| 192 |
+
"type": "string"
|
| 193 |
+
},
|
| 194 |
+
"type": {
|
| 195 |
+
"description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.",
|
| 196 |
+
"enum": [
|
| 197 |
+
"IMAGE",
|
| 198 |
+
"FLASH",
|
| 199 |
+
"VIDEO",
|
| 200 |
+
"HTML",
|
| 201 |
+
"HTML_IMAGE",
|
| 202 |
+
"AUDIO"
|
| 203 |
+
],
|
| 204 |
+
"enumDescriptions": [
|
| 205 |
+
"",
|
| 206 |
+
"",
|
| 207 |
+
"",
|
| 208 |
+
"",
|
| 209 |
+
"",
|
| 210 |
+
""
|
| 211 |
+
],
|
| 212 |
+
"type": "string"
|
| 213 |
+
}
|
| 214 |
+
},
|
| 215 |
+
"type": "object"
|
| 216 |
+
},
|
| 217 |
+
"CreativeAssetMetadata": {
|
| 218 |
+
"description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
|
| 219 |
+
"id": "CreativeAssetMetadata",
|
| 220 |
+
"properties": {
|
| 221 |
+
"assetIdentifier": {
|
| 222 |
+
"$ref": "CreativeAssetId",
|
| 223 |
+
"description": "ID of the creative asset. This is a required field."
|
| 224 |
+
},
|
| 225 |
+
"clickTags": {
|
| 226 |
+
"description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
|
| 227 |
+
"items": {
|
| 228 |
+
"$ref": "ClickTag"
|
| 229 |
+
},
|
| 230 |
+
"type": "array"
|
| 231 |
+
},
|
| 232 |
+
"counterCustomEvents": {
|
| 233 |
+
"description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
|
| 234 |
+
"items": {
|
| 235 |
+
"$ref": "CreativeCustomEvent"
|
| 236 |
+
},
|
| 237 |
+
"type": "array"
|
| 238 |
+
},
|
| 239 |
+
"detectedFeatures": {
|
| 240 |
+
"description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
|
| 241 |
+
"items": {
|
| 242 |
+
"enum": [
|
| 243 |
+
"CSS_FONT_FACE",
|
| 244 |
+
"CSS_BACKGROUND_SIZE",
|
| 245 |
+
"CSS_BORDER_IMAGE",
|
| 246 |
+
"CSS_BORDER_RADIUS",
|
| 247 |
+
"CSS_BOX_SHADOW",
|
| 248 |
+
"CSS_FLEX_BOX",
|
| 249 |
+
"CSS_HSLA",
|
| 250 |
+
"CSS_MULTIPLE_BGS",
|
| 251 |
+
"CSS_OPACITY",
|
| 252 |
+
"CSS_RGBA",
|
| 253 |
+
"CSS_TEXT_SHADOW",
|
| 254 |
+
"CSS_ANIMATIONS",
|
| 255 |
+
"CSS_COLUMNS",
|
| 256 |
+
"CSS_GENERATED_CONTENT",
|
| 257 |
+
"CSS_GRADIENTS",
|
| 258 |
+
"CSS_REFLECTIONS",
|
| 259 |
+
"CSS_TRANSFORMS",
|
| 260 |
+
"CSS_TRANSFORMS3D",
|
| 261 |
+
"CSS_TRANSITIONS",
|
| 262 |
+
"APPLICATION_CACHE",
|
| 263 |
+
"CANVAS",
|
| 264 |
+
"CANVAS_TEXT",
|
| 265 |
+
"DRAG_AND_DROP",
|
| 266 |
+
"HASH_CHANGE",
|
| 267 |
+
"HISTORY",
|
| 268 |
+
"AUDIO",
|
| 269 |
+
"VIDEO",
|
| 270 |
+
"INDEXED_DB",
|
| 271 |
+
"INPUT_ATTR_AUTOCOMPLETE",
|
| 272 |
+
"INPUT_ATTR_AUTOFOCUS",
|
| 273 |
+
"INPUT_ATTR_LIST",
|
| 274 |
+
"INPUT_ATTR_PLACEHOLDER",
|
| 275 |
+
"INPUT_ATTR_MAX",
|
| 276 |
+
"INPUT_ATTR_MIN",
|
| 277 |
+
"INPUT_ATTR_MULTIPLE",
|
| 278 |
+
"INPUT_ATTR_PATTERN",
|
| 279 |
+
"INPUT_ATTR_REQUIRED",
|
| 280 |
+
"INPUT_ATTR_STEP",
|
| 281 |
+
"INPUT_TYPE_SEARCH",
|
| 282 |
+
"INPUT_TYPE_TEL",
|
| 283 |
+
"INPUT_TYPE_URL",
|
| 284 |
+
"INPUT_TYPE_EMAIL",
|
| 285 |
+
"INPUT_TYPE_DATETIME",
|
| 286 |
+
"INPUT_TYPE_DATE",
|
| 287 |
+
"INPUT_TYPE_MONTH",
|
| 288 |
+
"INPUT_TYPE_WEEK",
|
| 289 |
+
"INPUT_TYPE_TIME",
|
| 290 |
+
"INPUT_TYPE_DATETIME_LOCAL",
|
| 291 |
+
"INPUT_TYPE_NUMBER",
|
| 292 |
+
"INPUT_TYPE_RANGE",
|
| 293 |
+
"INPUT_TYPE_COLOR",
|
| 294 |
+
"LOCAL_STORAGE",
|
| 295 |
+
"POST_MESSAGE",
|
| 296 |
+
"SESSION_STORAGE",
|
| 297 |
+
"WEB_SOCKETS",
|
| 298 |
+
"WEB_SQL_DATABASE",
|
| 299 |
+
"WEB_WORKERS",
|
| 300 |
+
"GEO_LOCATION",
|
| 301 |
+
"INLINE_SVG",
|
| 302 |
+
"SMIL",
|
| 303 |
+
"SVG_HREF",
|
| 304 |
+
"SVG_CLIP_PATHS",
|
| 305 |
+
"TOUCH",
|
| 306 |
+
"WEBGL",
|
| 307 |
+
"SVG_FILTERS",
|
| 308 |
+
"SVG_FE_IMAGE"
|
| 309 |
+
],
|
| 310 |
+
"enumDescriptions": [
|
| 311 |
+
"",
|
| 312 |
+
"",
|
| 313 |
+
"",
|
| 314 |
+
"",
|
| 315 |
+
"",
|
| 316 |
+
"",
|
| 317 |
+
"",
|
| 318 |
+
"",
|
| 319 |
+
"",
|
| 320 |
+
"",
|
| 321 |
+
"",
|
| 322 |
+
"",
|
| 323 |
+
"",
|
| 324 |
+
"",
|
| 325 |
+
"",
|
| 326 |
+
"",
|
| 327 |
+
"",
|
| 328 |
+
"",
|
| 329 |
+
"",
|
| 330 |
+
"",
|
| 331 |
+
"",
|
| 332 |
+
"",
|
| 333 |
+
"",
|
| 334 |
+
"",
|
| 335 |
+
"",
|
| 336 |
+
"",
|
| 337 |
+
"",
|
| 338 |
+
"",
|
| 339 |
+
"",
|
| 340 |
+
"",
|
| 341 |
+
"",
|
| 342 |
+
"",
|
| 343 |
+
"",
|
| 344 |
+
"",
|
| 345 |
+
"",
|
| 346 |
+
"",
|
| 347 |
+
"",
|
| 348 |
+
"",
|
| 349 |
+
"",
|
| 350 |
+
"",
|
| 351 |
+
"",
|
| 352 |
+
"",
|
| 353 |
+
"",
|
| 354 |
+
"",
|
| 355 |
+
"",
|
| 356 |
+
"",
|
| 357 |
+
"",
|
| 358 |
+
"",
|
| 359 |
+
"",
|
| 360 |
+
"",
|
| 361 |
+
"",
|
| 362 |
+
"",
|
| 363 |
+
"",
|
| 364 |
+
"",
|
| 365 |
+
"",
|
| 366 |
+
"",
|
| 367 |
+
"",
|
| 368 |
+
"",
|
| 369 |
+
"",
|
| 370 |
+
"",
|
| 371 |
+
"",
|
| 372 |
+
"",
|
| 373 |
+
"",
|
| 374 |
+
"",
|
| 375 |
+
"",
|
| 376 |
+
""
|
| 377 |
+
],
|
| 378 |
+
"type": "string"
|
| 379 |
+
},
|
| 380 |
+
"type": "array"
|
| 381 |
+
},
|
| 382 |
+
"exitCustomEvents": {
|
| 383 |
+
"description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
|
| 384 |
+
"items": {
|
| 385 |
+
"$ref": "CreativeCustomEvent"
|
| 386 |
+
},
|
| 387 |
+
"type": "array"
|
| 388 |
+
},
|
| 389 |
+
"id": {
|
| 390 |
+
"description": "Numeric ID of the asset. This is a read-only, auto-generated field.",
|
| 391 |
+
"format": "int64",
|
| 392 |
+
"type": "string"
|
| 393 |
+
},
|
| 394 |
+
"idDimensionValue": {
|
| 395 |
+
"$ref": "DimensionValue",
|
| 396 |
+
"description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field."
|
| 397 |
+
},
|
| 398 |
+
"kind": {
|
| 399 |
+
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
|
| 400 |
+
"type": "string"
|
| 401 |
+
},
|
| 402 |
+
"richMedia": {
|
| 403 |
+
"description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.",
|
| 404 |
+
"type": "boolean"
|
| 405 |
+
},
|
| 406 |
+
"timerCustomEvents": {
|
| 407 |
+
"description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
|
| 408 |
+
"items": {
|
| 409 |
+
"$ref": "CreativeCustomEvent"
|
| 410 |
+
},
|
| 411 |
+
"type": "array"
|
| 412 |
+
},
|
| 413 |
+
"warnedValidationRules": {
|
| 414 |
+
"description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ",
|
| 415 |
+
"items": {
|
| 416 |
+
"enum": [
|
| 417 |
+
"CLICK_TAG_NON_TOP_LEVEL",
|
| 418 |
+
"CLICK_TAG_MISSING",
|
| 419 |
+
"CLICK_TAG_MORE_THAN_ONE",
|
| 420 |
+
"CLICK_TAG_INVALID",
|
| 421 |
+
"ORPHANED_ASSET",
|
| 422 |
+
"PRIMARY_HTML_MISSING",
|
| 423 |
+
"EXTERNAL_FILE_REFERENCED",
|
| 424 |
+
"MRAID_REFERENCED",
|
| 425 |
+
"ADMOB_REFERENCED",
|
| 426 |
+
"FILE_TYPE_INVALID",
|
| 427 |
+
"ZIP_INVALID",
|
| 428 |
+
"LINKED_FILE_NOT_FOUND",
|
| 429 |
+
"MAX_FLASH_VERSION_11",
|
| 430 |
+
"NOT_SSL_COMPLIANT",
|
| 431 |
+
"FILE_DETAIL_EMPTY",
|
| 432 |
+
"ASSET_INVALID",
|
| 433 |
+
"GWD_PROPERTIES_INVALID",
|
| 434 |
+
"ENABLER_UNSUPPORTED_METHOD_DCM",
|
| 435 |
+
"ASSET_FORMAT_UNSUPPORTED_DCM",
|
| 436 |
+
"COMPONENT_UNSUPPORTED_DCM",
|
| 437 |
+
"HTML5_FEATURE_UNSUPPORTED",
|
| 438 |
+
"CLICK_TAG_IN_GWD",
|
| 439 |
+
"CLICK_TAG_HARD_CODED",
|
| 440 |
+
"SVG_INVALID",
|
| 441 |
+
"CLICK_TAG_IN_RICH_MEDIA",
|
| 442 |
+
"MISSING_ENABLER_REFERENCE"
|
| 443 |
+
],
|
| 444 |
+
"enumDescriptions": [
|
| 445 |
+
"",
|
| 446 |
+
"",
|
| 447 |
+
"",
|
| 448 |
+
"",
|
| 449 |
+
"",
|
| 450 |
+
"",
|
| 451 |
+
"",
|
| 452 |
+
"",
|
| 453 |
+
"",
|
| 454 |
+
"",
|
| 455 |
+
"",
|
| 456 |
+
"",
|
| 457 |
+
"",
|
| 458 |
+
"",
|
| 459 |
+
"",
|
| 460 |
+
"",
|
| 461 |
+
"",
|
| 462 |
+
"",
|
| 463 |
+
"",
|
| 464 |
+
"",
|
| 465 |
+
"",
|
| 466 |
+
"",
|
| 467 |
+
"",
|
| 468 |
+
"",
|
| 469 |
+
"",
|
| 470 |
+
""
|
| 471 |
+
],
|
| 472 |
+
"type": "string"
|
| 473 |
+
},
|
| 474 |
+
"type": "array"
|
| 475 |
+
}
|
| 476 |
+
},
|
| 477 |
+
"type": "object"
|
| 478 |
+
},
|
| 479 |
+
"CreativeClickThroughUrl": {
|
| 480 |
+
"description": "Click-through URL",
|
| 481 |
+
"id": "CreativeClickThroughUrl",
|
| 482 |
+
"properties": {
|
| 483 |
+
"computedClickThroughUrl": {
|
| 484 |
+
"description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
|
| 485 |
+
"type": "string"
|
| 486 |
+
},
|
| 487 |
+
"customClickThroughUrl": {
|
| 488 |
+
"description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
|
| 489 |
+
"type": "string"
|
| 490 |
+
},
|
| 491 |
+
"landingPageId": {
|
| 492 |
+
"description": "ID of the landing page for the click-through URL.",
|
| 493 |
+
"format": "int64",
|
| 494 |
+
"type": "string"
|
| 495 |
+
}
|
| 496 |
+
},
|
| 497 |
+
"type": "object"
|
| 498 |
+
},
|
| 499 |
+
"CreativeCustomEvent": {
|
| 500 |
+
"description": "Creative Custom Event.",
|
| 501 |
+
"id": "CreativeCustomEvent",
|
| 502 |
+
"properties": {
|
| 503 |
+
"advertiserCustomEventId": {
|
| 504 |
+
"description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
|
| 505 |
+
"format": "int64",
|
| 506 |
+
"type": "string"
|
| 507 |
+
},
|
| 508 |
+
"advertiserCustomEventName": {
|
| 509 |
+
"description": "User-entered name for the event.",
|
| 510 |
+
"type": "string"
|
| 511 |
+
},
|
| 512 |
+
"advertiserCustomEventType": {
|
| 513 |
+
"description": "Type of the event. This is a read-only field.",
|
| 514 |
+
"enum": [
|
| 515 |
+
"ADVERTISER_EVENT_TIMER",
|
| 516 |
+
"ADVERTISER_EVENT_EXIT",
|
| 517 |
+
"ADVERTISER_EVENT_COUNTER"
|
| 518 |
+
],
|
| 519 |
+
"enumDescriptions": [
|
| 520 |
+
"",
|
| 521 |
+
"",
|
| 522 |
+
""
|
| 523 |
+
],
|
| 524 |
+
"type": "string"
|
| 525 |
+
},
|
| 526 |
+
"artworkLabel": {
|
| 527 |
+
"description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
|
| 528 |
+
"type": "string"
|
| 529 |
+
},
|
| 530 |
+
"artworkType": {
|
| 531 |
+
"description": "Artwork type used by the creative.This is a read-only field.",
|
| 532 |
+
"enum": [
|
| 533 |
+
"ARTWORK_TYPE_FLASH",
|
| 534 |
+
"ARTWORK_TYPE_HTML5",
|
| 535 |
+
"ARTWORK_TYPE_MIXED",
|
| 536 |
+
"ARTWORK_TYPE_IMAGE"
|
| 537 |
+
],
|
| 538 |
+
"enumDescriptions": [
|
| 539 |
+
"",
|
| 540 |
+
"",
|
| 541 |
+
"",
|
| 542 |
+
""
|
| 543 |
+
],
|
| 544 |
+
"type": "string"
|
| 545 |
+
},
|
| 546 |
+
"exitClickThroughUrl": {
|
| 547 |
+
"$ref": "CreativeClickThroughUrl",
|
| 548 |
+
"description": "Exit click-through URL for the event. This field is used only for exit events."
|
| 549 |
+
},
|
| 550 |
+
"id": {
|
| 551 |
+
"description": "ID of this event. This is a required field and should not be modified after insertion.",
|
| 552 |
+
"format": "int64",
|
| 553 |
+
"type": "string"
|
| 554 |
+
},
|
| 555 |
+
"popupWindowProperties": {
|
| 556 |
+
"$ref": "PopupWindowProperties",
|
| 557 |
+
"description": "Properties for rich media popup windows. This field is used only for exit events."
|
| 558 |
+
},
|
| 559 |
+
"targetType": {
|
| 560 |
+
"description": "Target type used by the event.",
|
| 561 |
+
"enum": [
|
| 562 |
+
"TARGET_BLANK",
|
| 563 |
+
"TARGET_TOP",
|
| 564 |
+
"TARGET_SELF",
|
| 565 |
+
"TARGET_PARENT",
|
| 566 |
+
"TARGET_POPUP"
|
| 567 |
+
],
|
| 568 |
+
"enumDescriptions": [
|
| 569 |
+
"",
|
| 570 |
+
"",
|
| 571 |
+
"",
|
| 572 |
+
"",
|
| 573 |
+
""
|
| 574 |
+
],
|
| 575 |
+
"type": "string"
|
| 576 |
+
},
|
| 577 |
+
"videoReportingId": {
|
| 578 |
+
"description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
|
| 579 |
+
"type": "string"
|
| 580 |
+
}
|
| 581 |
+
},
|
| 582 |
+
"type": "object"
|
| 583 |
+
},
|
| 584 |
+
"DimensionValue": {
|
| 585 |
+
"description": "Represents a DimensionValue resource.",
|
| 586 |
+
"id": "DimensionValue",
|
| 587 |
+
"properties": {
|
| 588 |
+
"dimensionName": {
|
| 589 |
+
"description": "The name of the dimension.",
|
| 590 |
+
"type": "string"
|
| 591 |
+
},
|
| 592 |
+
"etag": {
|
| 593 |
+
"description": "The eTag of this response for caching purposes.",
|
| 594 |
+
"type": "string"
|
| 595 |
+
},
|
| 596 |
+
"id": {
|
| 597 |
+
"description": "The ID associated with the value if available.",
|
| 598 |
+
"type": "string"
|
| 599 |
+
},
|
| 600 |
+
"kind": {
|
| 601 |
+
"description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
|
| 602 |
+
"type": "string"
|
| 603 |
+
},
|
| 604 |
+
"matchType": {
|
| 605 |
+
"description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
|
| 606 |
+
"enum": [
|
| 607 |
+
"EXACT",
|
| 608 |
+
"BEGINS_WITH",
|
| 609 |
+
"CONTAINS",
|
| 610 |
+
"WILDCARD_EXPRESSION"
|
| 611 |
+
],
|
| 612 |
+
"enumDescriptions": [
|
| 613 |
+
"",
|
| 614 |
+
"",
|
| 615 |
+
"",
|
| 616 |
+
""
|
| 617 |
+
],
|
| 618 |
+
"type": "string"
|
| 619 |
+
},
|
| 620 |
+
"value": {
|
| 621 |
+
"description": "The value of the dimension.",
|
| 622 |
+
"type": "string"
|
| 623 |
+
}
|
| 624 |
+
},
|
| 625 |
+
"type": "object"
|
| 626 |
+
},
|
| 627 |
+
"OffsetPosition": {
|
| 628 |
+
"description": "Offset Position.",
|
| 629 |
+
"id": "OffsetPosition",
|
| 630 |
+
"properties": {
|
| 631 |
+
"left": {
|
| 632 |
+
"description": "Offset distance from left side of an asset or a window.",
|
| 633 |
+
"format": "int32",
|
| 634 |
+
"type": "integer"
|
| 635 |
+
},
|
| 636 |
+
"top": {
|
| 637 |
+
"description": "Offset distance from top side of an asset or a window.",
|
| 638 |
+
"format": "int32",
|
| 639 |
+
"type": "integer"
|
| 640 |
+
}
|
| 641 |
+
},
|
| 642 |
+
"type": "object"
|
| 643 |
+
},
|
| 644 |
+
"PopupWindowProperties": {
|
| 645 |
+
"description": "Popup Window Properties.",
|
| 646 |
+
"id": "PopupWindowProperties",
|
| 647 |
+
"properties": {
|
| 648 |
+
"dimension": {
|
| 649 |
+
"$ref": "Size",
|
| 650 |
+
"description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
|
| 651 |
+
},
|
| 652 |
+
"offset": {
|
| 653 |
+
"$ref": "OffsetPosition",
|
| 654 |
+
"description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
|
| 655 |
+
},
|
| 656 |
+
"positionType": {
|
| 657 |
+
"description": "Popup window position either centered or at specific coordinate.",
|
| 658 |
+
"enum": [
|
| 659 |
+
"CENTER",
|
| 660 |
+
"COORDINATES"
|
| 661 |
+
],
|
| 662 |
+
"enumDescriptions": [
|
| 663 |
+
"",
|
| 664 |
+
""
|
| 665 |
+
],
|
| 666 |
+
"type": "string"
|
| 667 |
+
},
|
| 668 |
+
"showAddressBar": {
|
| 669 |
+
"description": "Whether to display the browser address bar.",
|
| 670 |
+
"type": "boolean"
|
| 671 |
+
},
|
| 672 |
+
"showMenuBar": {
|
| 673 |
+
"description": "Whether to display the browser menu bar.",
|
| 674 |
+
"type": "boolean"
|
| 675 |
+
},
|
| 676 |
+
"showScrollBar": {
|
| 677 |
+
"description": "Whether to display the browser scroll bar.",
|
| 678 |
+
"type": "boolean"
|
| 679 |
+
},
|
| 680 |
+
"showStatusBar": {
|
| 681 |
+
"description": "Whether to display the browser status bar.",
|
| 682 |
+
"type": "boolean"
|
| 683 |
+
},
|
| 684 |
+
"showToolBar": {
|
| 685 |
+
"description": "Whether to display the browser tool bar.",
|
| 686 |
+
"type": "boolean"
|
| 687 |
+
},
|
| 688 |
+
"title": {
|
| 689 |
+
"description": "Title of popup window.",
|
| 690 |
+
"type": "string"
|
| 691 |
+
}
|
| 692 |
+
},
|
| 693 |
+
"type": "object"
|
| 694 |
+
},
|
| 695 |
+
"Size": {
|
| 696 |
+
"description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
|
| 697 |
+
"id": "Size",
|
| 698 |
+
"properties": {
|
| 699 |
+
"height": {
|
| 700 |
+
"description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
|
| 701 |
+
"format": "int32",
|
| 702 |
+
"type": "integer"
|
| 703 |
+
},
|
| 704 |
+
"iab": {
|
| 705 |
+
"description": "IAB standard size. This is a read-only, auto-generated field.",
|
| 706 |
+
"type": "boolean"
|
| 707 |
+
},
|
| 708 |
+
"id": {
|
| 709 |
+
"description": "ID of this size. This is a read-only, auto-generated field.",
|
| 710 |
+
"format": "int64",
|
| 711 |
+
"type": "string"
|
| 712 |
+
},
|
| 713 |
+
"kind": {
|
| 714 |
+
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
|
| 715 |
+
"type": "string"
|
| 716 |
+
},
|
| 717 |
+
"width": {
|
| 718 |
+
"description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
|
| 719 |
+
"format": "int32",
|
| 720 |
+
"type": "integer"
|
| 721 |
+
}
|
| 722 |
+
},
|
| 723 |
+
"type": "object"
|
| 724 |
+
}
|
| 725 |
+
},
|
| 726 |
+
"servicePath": "dfareporting/v3.5/",
|
| 727 |
+
"title": "Campaign Manager 360 API",
|
| 728 |
+
"version": "v3.5"
|
| 729 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dfareporting.v4.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/domains.v1beta1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/drive.v3.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/eventarc.v1.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json
ADDED
|
@@ -0,0 +1,1103 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://eventarc.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Eventarc",
|
| 15 |
+
"description": "Build event-driven applications on Google Cloud Platform.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/eventarc",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "eventarc:v1beta1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://eventarc.mtls.googleapis.com/",
|
| 26 |
+
"name": "eventarc",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"projects": {
|
| 109 |
+
"resources": {
|
| 110 |
+
"locations": {
|
| 111 |
+
"methods": {
|
| 112 |
+
"get": {
|
| 113 |
+
"description": "Gets information about a location.",
|
| 114 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
|
| 115 |
+
"httpMethod": "GET",
|
| 116 |
+
"id": "eventarc.projects.locations.get",
|
| 117 |
+
"parameterOrder": [
|
| 118 |
+
"name"
|
| 119 |
+
],
|
| 120 |
+
"parameters": {
|
| 121 |
+
"name": {
|
| 122 |
+
"description": "Resource name for the location.",
|
| 123 |
+
"location": "path",
|
| 124 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 125 |
+
"required": true,
|
| 126 |
+
"type": "string"
|
| 127 |
+
}
|
| 128 |
+
},
|
| 129 |
+
"path": "v1beta1/{+name}",
|
| 130 |
+
"response": {
|
| 131 |
+
"$ref": "Location"
|
| 132 |
+
},
|
| 133 |
+
"scopes": [
|
| 134 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 135 |
+
]
|
| 136 |
+
},
|
| 137 |
+
"list": {
|
| 138 |
+
"description": "Lists information about the supported locations for this service.",
|
| 139 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations",
|
| 140 |
+
"httpMethod": "GET",
|
| 141 |
+
"id": "eventarc.projects.locations.list",
|
| 142 |
+
"parameterOrder": [
|
| 143 |
+
"name"
|
| 144 |
+
],
|
| 145 |
+
"parameters": {
|
| 146 |
+
"filter": {
|
| 147 |
+
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
|
| 148 |
+
"location": "query",
|
| 149 |
+
"type": "string"
|
| 150 |
+
},
|
| 151 |
+
"name": {
|
| 152 |
+
"description": "The resource that owns the locations collection, if applicable.",
|
| 153 |
+
"location": "path",
|
| 154 |
+
"pattern": "^projects/[^/]+$",
|
| 155 |
+
"required": true,
|
| 156 |
+
"type": "string"
|
| 157 |
+
},
|
| 158 |
+
"pageSize": {
|
| 159 |
+
"description": "The maximum number of results to return. If not set, the service selects a default.",
|
| 160 |
+
"format": "int32",
|
| 161 |
+
"location": "query",
|
| 162 |
+
"type": "integer"
|
| 163 |
+
},
|
| 164 |
+
"pageToken": {
|
| 165 |
+
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
|
| 166 |
+
"location": "query",
|
| 167 |
+
"type": "string"
|
| 168 |
+
}
|
| 169 |
+
},
|
| 170 |
+
"path": "v1beta1/{+name}/locations",
|
| 171 |
+
"response": {
|
| 172 |
+
"$ref": "ListLocationsResponse"
|
| 173 |
+
},
|
| 174 |
+
"scopes": [
|
| 175 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 176 |
+
]
|
| 177 |
+
}
|
| 178 |
+
},
|
| 179 |
+
"resources": {
|
| 180 |
+
"operations": {
|
| 181 |
+
"methods": {
|
| 182 |
+
"cancel": {
|
| 183 |
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 184 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
|
| 185 |
+
"httpMethod": "POST",
|
| 186 |
+
"id": "eventarc.projects.locations.operations.cancel",
|
| 187 |
+
"parameterOrder": [
|
| 188 |
+
"name"
|
| 189 |
+
],
|
| 190 |
+
"parameters": {
|
| 191 |
+
"name": {
|
| 192 |
+
"description": "The name of the operation resource to be cancelled.",
|
| 193 |
+
"location": "path",
|
| 194 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 195 |
+
"required": true,
|
| 196 |
+
"type": "string"
|
| 197 |
+
}
|
| 198 |
+
},
|
| 199 |
+
"path": "v1beta1/{+name}:cancel",
|
| 200 |
+
"request": {
|
| 201 |
+
"$ref": "CancelOperationRequest"
|
| 202 |
+
},
|
| 203 |
+
"response": {
|
| 204 |
+
"$ref": "Empty"
|
| 205 |
+
},
|
| 206 |
+
"scopes": [
|
| 207 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 208 |
+
]
|
| 209 |
+
},
|
| 210 |
+
"delete": {
|
| 211 |
+
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
|
| 212 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
| 213 |
+
"httpMethod": "DELETE",
|
| 214 |
+
"id": "eventarc.projects.locations.operations.delete",
|
| 215 |
+
"parameterOrder": [
|
| 216 |
+
"name"
|
| 217 |
+
],
|
| 218 |
+
"parameters": {
|
| 219 |
+
"name": {
|
| 220 |
+
"description": "The name of the operation resource to be deleted.",
|
| 221 |
+
"location": "path",
|
| 222 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 223 |
+
"required": true,
|
| 224 |
+
"type": "string"
|
| 225 |
+
}
|
| 226 |
+
},
|
| 227 |
+
"path": "v1beta1/{+name}",
|
| 228 |
+
"response": {
|
| 229 |
+
"$ref": "Empty"
|
| 230 |
+
},
|
| 231 |
+
"scopes": [
|
| 232 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 233 |
+
]
|
| 234 |
+
},
|
| 235 |
+
"get": {
|
| 236 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 237 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
| 238 |
+
"httpMethod": "GET",
|
| 239 |
+
"id": "eventarc.projects.locations.operations.get",
|
| 240 |
+
"parameterOrder": [
|
| 241 |
+
"name"
|
| 242 |
+
],
|
| 243 |
+
"parameters": {
|
| 244 |
+
"name": {
|
| 245 |
+
"description": "The name of the operation resource.",
|
| 246 |
+
"location": "path",
|
| 247 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 248 |
+
"required": true,
|
| 249 |
+
"type": "string"
|
| 250 |
+
}
|
| 251 |
+
},
|
| 252 |
+
"path": "v1beta1/{+name}",
|
| 253 |
+
"response": {
|
| 254 |
+
"$ref": "Operation"
|
| 255 |
+
},
|
| 256 |
+
"scopes": [
|
| 257 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 258 |
+
]
|
| 259 |
+
},
|
| 260 |
+
"list": {
|
| 261 |
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
| 262 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
|
| 263 |
+
"httpMethod": "GET",
|
| 264 |
+
"id": "eventarc.projects.locations.operations.list",
|
| 265 |
+
"parameterOrder": [
|
| 266 |
+
"name"
|
| 267 |
+
],
|
| 268 |
+
"parameters": {
|
| 269 |
+
"filter": {
|
| 270 |
+
"description": "The standard list filter.",
|
| 271 |
+
"location": "query",
|
| 272 |
+
"type": "string"
|
| 273 |
+
},
|
| 274 |
+
"name": {
|
| 275 |
+
"description": "The name of the operation's parent resource.",
|
| 276 |
+
"location": "path",
|
| 277 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 278 |
+
"required": true,
|
| 279 |
+
"type": "string"
|
| 280 |
+
},
|
| 281 |
+
"pageSize": {
|
| 282 |
+
"description": "The standard list page size.",
|
| 283 |
+
"format": "int32",
|
| 284 |
+
"location": "query",
|
| 285 |
+
"type": "integer"
|
| 286 |
+
},
|
| 287 |
+
"pageToken": {
|
| 288 |
+
"description": "The standard list page token.",
|
| 289 |
+
"location": "query",
|
| 290 |
+
"type": "string"
|
| 291 |
+
}
|
| 292 |
+
},
|
| 293 |
+
"path": "v1beta1/{+name}/operations",
|
| 294 |
+
"response": {
|
| 295 |
+
"$ref": "ListOperationsResponse"
|
| 296 |
+
},
|
| 297 |
+
"scopes": [
|
| 298 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 299 |
+
]
|
| 300 |
+
}
|
| 301 |
+
}
|
| 302 |
+
},
|
| 303 |
+
"triggers": {
|
| 304 |
+
"methods": {
|
| 305 |
+
"create": {
|
| 306 |
+
"description": "Create a new trigger in a particular project and location.",
|
| 307 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers",
|
| 308 |
+
"httpMethod": "POST",
|
| 309 |
+
"id": "eventarc.projects.locations.triggers.create",
|
| 310 |
+
"parameterOrder": [
|
| 311 |
+
"parent"
|
| 312 |
+
],
|
| 313 |
+
"parameters": {
|
| 314 |
+
"parent": {
|
| 315 |
+
"description": "Required. The parent collection in which to add this trigger.",
|
| 316 |
+
"location": "path",
|
| 317 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 318 |
+
"required": true,
|
| 319 |
+
"type": "string"
|
| 320 |
+
},
|
| 321 |
+
"triggerId": {
|
| 322 |
+
"description": "Required. The user-provided ID to be assigned to the trigger.",
|
| 323 |
+
"location": "query",
|
| 324 |
+
"type": "string"
|
| 325 |
+
},
|
| 326 |
+
"validateOnly": {
|
| 327 |
+
"description": "Required. If set, validate the request and preview the review, but do not actually post it.",
|
| 328 |
+
"location": "query",
|
| 329 |
+
"type": "boolean"
|
| 330 |
+
}
|
| 331 |
+
},
|
| 332 |
+
"path": "v1beta1/{+parent}/triggers",
|
| 333 |
+
"request": {
|
| 334 |
+
"$ref": "Trigger"
|
| 335 |
+
},
|
| 336 |
+
"response": {
|
| 337 |
+
"$ref": "Operation"
|
| 338 |
+
},
|
| 339 |
+
"scopes": [
|
| 340 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 341 |
+
]
|
| 342 |
+
},
|
| 343 |
+
"delete": {
|
| 344 |
+
"description": "Delete a single trigger.",
|
| 345 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}",
|
| 346 |
+
"httpMethod": "DELETE",
|
| 347 |
+
"id": "eventarc.projects.locations.triggers.delete",
|
| 348 |
+
"parameterOrder": [
|
| 349 |
+
"name"
|
| 350 |
+
],
|
| 351 |
+
"parameters": {
|
| 352 |
+
"allowMissing": {
|
| 353 |
+
"description": "If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.",
|
| 354 |
+
"location": "query",
|
| 355 |
+
"type": "boolean"
|
| 356 |
+
},
|
| 357 |
+
"etag": {
|
| 358 |
+
"description": "If provided, the trigger will only be deleted if the etag matches the current etag on the resource.",
|
| 359 |
+
"location": "query",
|
| 360 |
+
"type": "string"
|
| 361 |
+
},
|
| 362 |
+
"name": {
|
| 363 |
+
"description": "Required. The name of the trigger to be deleted.",
|
| 364 |
+
"location": "path",
|
| 365 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 366 |
+
"required": true,
|
| 367 |
+
"type": "string"
|
| 368 |
+
},
|
| 369 |
+
"validateOnly": {
|
| 370 |
+
"description": "Required. If set, validate the request and preview the review, but do not actually post it.",
|
| 371 |
+
"location": "query",
|
| 372 |
+
"type": "boolean"
|
| 373 |
+
}
|
| 374 |
+
},
|
| 375 |
+
"path": "v1beta1/{+name}",
|
| 376 |
+
"response": {
|
| 377 |
+
"$ref": "Operation"
|
| 378 |
+
},
|
| 379 |
+
"scopes": [
|
| 380 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 381 |
+
]
|
| 382 |
+
},
|
| 383 |
+
"get": {
|
| 384 |
+
"description": "Get a single trigger.",
|
| 385 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}",
|
| 386 |
+
"httpMethod": "GET",
|
| 387 |
+
"id": "eventarc.projects.locations.triggers.get",
|
| 388 |
+
"parameterOrder": [
|
| 389 |
+
"name"
|
| 390 |
+
],
|
| 391 |
+
"parameters": {
|
| 392 |
+
"name": {
|
| 393 |
+
"description": "Required. The name of the trigger to get.",
|
| 394 |
+
"location": "path",
|
| 395 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 396 |
+
"required": true,
|
| 397 |
+
"type": "string"
|
| 398 |
+
}
|
| 399 |
+
},
|
| 400 |
+
"path": "v1beta1/{+name}",
|
| 401 |
+
"response": {
|
| 402 |
+
"$ref": "Trigger"
|
| 403 |
+
},
|
| 404 |
+
"scopes": [
|
| 405 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 406 |
+
]
|
| 407 |
+
},
|
| 408 |
+
"getIamPolicy": {
|
| 409 |
+
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
|
| 410 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:getIamPolicy",
|
| 411 |
+
"httpMethod": "GET",
|
| 412 |
+
"id": "eventarc.projects.locations.triggers.getIamPolicy",
|
| 413 |
+
"parameterOrder": [
|
| 414 |
+
"resource"
|
| 415 |
+
],
|
| 416 |
+
"parameters": {
|
| 417 |
+
"options.requestedPolicyVersion": {
|
| 418 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 419 |
+
"format": "int32",
|
| 420 |
+
"location": "query",
|
| 421 |
+
"type": "integer"
|
| 422 |
+
},
|
| 423 |
+
"resource": {
|
| 424 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 425 |
+
"location": "path",
|
| 426 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 427 |
+
"required": true,
|
| 428 |
+
"type": "string"
|
| 429 |
+
}
|
| 430 |
+
},
|
| 431 |
+
"path": "v1beta1/{+resource}:getIamPolicy",
|
| 432 |
+
"response": {
|
| 433 |
+
"$ref": "Policy"
|
| 434 |
+
},
|
| 435 |
+
"scopes": [
|
| 436 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 437 |
+
]
|
| 438 |
+
},
|
| 439 |
+
"list": {
|
| 440 |
+
"description": "List triggers.",
|
| 441 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers",
|
| 442 |
+
"httpMethod": "GET",
|
| 443 |
+
"id": "eventarc.projects.locations.triggers.list",
|
| 444 |
+
"parameterOrder": [
|
| 445 |
+
"parent"
|
| 446 |
+
],
|
| 447 |
+
"parameters": {
|
| 448 |
+
"orderBy": {
|
| 449 |
+
"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a ` desc` suffix; for example: `name desc, trigger_id`.",
|
| 450 |
+
"location": "query",
|
| 451 |
+
"type": "string"
|
| 452 |
+
},
|
| 453 |
+
"pageSize": {
|
| 454 |
+
"description": "The maximum number of triggers to return on each page. Note: The service may send fewer.",
|
| 455 |
+
"format": "int32",
|
| 456 |
+
"location": "query",
|
| 457 |
+
"type": "integer"
|
| 458 |
+
},
|
| 459 |
+
"pageToken": {
|
| 460 |
+
"description": "The page token; provide the value from the `next_page_token` field in a previous `ListTriggers` call to retrieve the subsequent page. When paginating, all other parameters provided to `ListTriggers` must match the call that provided the page token.",
|
| 461 |
+
"location": "query",
|
| 462 |
+
"type": "string"
|
| 463 |
+
},
|
| 464 |
+
"parent": {
|
| 465 |
+
"description": "Required. The parent collection to list triggers on.",
|
| 466 |
+
"location": "path",
|
| 467 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 468 |
+
"required": true,
|
| 469 |
+
"type": "string"
|
| 470 |
+
}
|
| 471 |
+
},
|
| 472 |
+
"path": "v1beta1/{+parent}/triggers",
|
| 473 |
+
"response": {
|
| 474 |
+
"$ref": "ListTriggersResponse"
|
| 475 |
+
},
|
| 476 |
+
"scopes": [
|
| 477 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 478 |
+
]
|
| 479 |
+
},
|
| 480 |
+
"patch": {
|
| 481 |
+
"description": "Update a single trigger.",
|
| 482 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}",
|
| 483 |
+
"httpMethod": "PATCH",
|
| 484 |
+
"id": "eventarc.projects.locations.triggers.patch",
|
| 485 |
+
"parameterOrder": [
|
| 486 |
+
"name"
|
| 487 |
+
],
|
| 488 |
+
"parameters": {
|
| 489 |
+
"allowMissing": {
|
| 490 |
+
"description": "If set to true, and the trigger is not found, a new trigger will be created. In this situation, `update_mask` is ignored.",
|
| 491 |
+
"location": "query",
|
| 492 |
+
"type": "boolean"
|
| 493 |
+
},
|
| 494 |
+
"name": {
|
| 495 |
+
"description": "Required. The resource name of the trigger. Must be unique within the location on the project and must in `projects/{project}/locations/{location}/triggers/{trigger}` format.",
|
| 496 |
+
"location": "path",
|
| 497 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 498 |
+
"required": true,
|
| 499 |
+
"type": "string"
|
| 500 |
+
},
|
| 501 |
+
"updateMask": {
|
| 502 |
+
"description": "The fields to be updated; only fields explicitly provided will be updated. If no field mask is provided, all provided fields in the request will be updated. To update all fields, provide a field mask of \"*\".",
|
| 503 |
+
"format": "google-fieldmask",
|
| 504 |
+
"location": "query",
|
| 505 |
+
"type": "string"
|
| 506 |
+
},
|
| 507 |
+
"validateOnly": {
|
| 508 |
+
"description": "Required. If set, validate the request and preview the review, but do not actually post it.",
|
| 509 |
+
"location": "query",
|
| 510 |
+
"type": "boolean"
|
| 511 |
+
}
|
| 512 |
+
},
|
| 513 |
+
"path": "v1beta1/{+name}",
|
| 514 |
+
"request": {
|
| 515 |
+
"$ref": "Trigger"
|
| 516 |
+
},
|
| 517 |
+
"response": {
|
| 518 |
+
"$ref": "Operation"
|
| 519 |
+
},
|
| 520 |
+
"scopes": [
|
| 521 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 522 |
+
]
|
| 523 |
+
},
|
| 524 |
+
"setIamPolicy": {
|
| 525 |
+
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
|
| 526 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:setIamPolicy",
|
| 527 |
+
"httpMethod": "POST",
|
| 528 |
+
"id": "eventarc.projects.locations.triggers.setIamPolicy",
|
| 529 |
+
"parameterOrder": [
|
| 530 |
+
"resource"
|
| 531 |
+
],
|
| 532 |
+
"parameters": {
|
| 533 |
+
"resource": {
|
| 534 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 535 |
+
"location": "path",
|
| 536 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 537 |
+
"required": true,
|
| 538 |
+
"type": "string"
|
| 539 |
+
}
|
| 540 |
+
},
|
| 541 |
+
"path": "v1beta1/{+resource}:setIamPolicy",
|
| 542 |
+
"request": {
|
| 543 |
+
"$ref": "SetIamPolicyRequest"
|
| 544 |
+
},
|
| 545 |
+
"response": {
|
| 546 |
+
"$ref": "Policy"
|
| 547 |
+
},
|
| 548 |
+
"scopes": [
|
| 549 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 550 |
+
]
|
| 551 |
+
},
|
| 552 |
+
"testIamPermissions": {
|
| 553 |
+
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.",
|
| 554 |
+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:testIamPermissions",
|
| 555 |
+
"httpMethod": "POST",
|
| 556 |
+
"id": "eventarc.projects.locations.triggers.testIamPermissions",
|
| 557 |
+
"parameterOrder": [
|
| 558 |
+
"resource"
|
| 559 |
+
],
|
| 560 |
+
"parameters": {
|
| 561 |
+
"resource": {
|
| 562 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 563 |
+
"location": "path",
|
| 564 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$",
|
| 565 |
+
"required": true,
|
| 566 |
+
"type": "string"
|
| 567 |
+
}
|
| 568 |
+
},
|
| 569 |
+
"path": "v1beta1/{+resource}:testIamPermissions",
|
| 570 |
+
"request": {
|
| 571 |
+
"$ref": "TestIamPermissionsRequest"
|
| 572 |
+
},
|
| 573 |
+
"response": {
|
| 574 |
+
"$ref": "TestIamPermissionsResponse"
|
| 575 |
+
},
|
| 576 |
+
"scopes": [
|
| 577 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 578 |
+
]
|
| 579 |
+
}
|
| 580 |
+
}
|
| 581 |
+
}
|
| 582 |
+
}
|
| 583 |
+
}
|
| 584 |
+
}
|
| 585 |
+
}
|
| 586 |
+
},
|
| 587 |
+
"revision": "20240417",
|
| 588 |
+
"rootUrl": "https://eventarc.googleapis.com/",
|
| 589 |
+
"schemas": {
|
| 590 |
+
"AuditConfig": {
|
| 591 |
+
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
|
| 592 |
+
"id": "AuditConfig",
|
| 593 |
+
"properties": {
|
| 594 |
+
"auditLogConfigs": {
|
| 595 |
+
"description": "The configuration for logging of each type of permission.",
|
| 596 |
+
"items": {
|
| 597 |
+
"$ref": "AuditLogConfig"
|
| 598 |
+
},
|
| 599 |
+
"type": "array"
|
| 600 |
+
},
|
| 601 |
+
"service": {
|
| 602 |
+
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
|
| 603 |
+
"type": "string"
|
| 604 |
+
}
|
| 605 |
+
},
|
| 606 |
+
"type": "object"
|
| 607 |
+
},
|
| 608 |
+
"AuditLogConfig": {
|
| 609 |
+
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
|
| 610 |
+
"id": "AuditLogConfig",
|
| 611 |
+
"properties": {
|
| 612 |
+
"exemptedMembers": {
|
| 613 |
+
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
|
| 614 |
+
"items": {
|
| 615 |
+
"type": "string"
|
| 616 |
+
},
|
| 617 |
+
"type": "array"
|
| 618 |
+
},
|
| 619 |
+
"logType": {
|
| 620 |
+
"description": "The log type that this config enables.",
|
| 621 |
+
"enum": [
|
| 622 |
+
"LOG_TYPE_UNSPECIFIED",
|
| 623 |
+
"ADMIN_READ",
|
| 624 |
+
"DATA_WRITE",
|
| 625 |
+
"DATA_READ"
|
| 626 |
+
],
|
| 627 |
+
"enumDescriptions": [
|
| 628 |
+
"Default case. Should never be this.",
|
| 629 |
+
"Admin reads. Example: CloudIAM getIamPolicy",
|
| 630 |
+
"Data writes. Example: CloudSQL Users create",
|
| 631 |
+
"Data reads. Example: CloudSQL Users list"
|
| 632 |
+
],
|
| 633 |
+
"type": "string"
|
| 634 |
+
}
|
| 635 |
+
},
|
| 636 |
+
"type": "object"
|
| 637 |
+
},
|
| 638 |
+
"Binding": {
|
| 639 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 640 |
+
"id": "Binding",
|
| 641 |
+
"properties": {
|
| 642 |
+
"condition": {
|
| 643 |
+
"$ref": "Expr",
|
| 644 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 645 |
+
},
|
| 646 |
+
"members": {
|
| 647 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 648 |
+
"items": {
|
| 649 |
+
"type": "string"
|
| 650 |
+
},
|
| 651 |
+
"type": "array"
|
| 652 |
+
},
|
| 653 |
+
"role": {
|
| 654 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 655 |
+
"type": "string"
|
| 656 |
+
}
|
| 657 |
+
},
|
| 658 |
+
"type": "object"
|
| 659 |
+
},
|
| 660 |
+
"CancelOperationRequest": {
|
| 661 |
+
"description": "The request message for Operations.CancelOperation.",
|
| 662 |
+
"id": "CancelOperationRequest",
|
| 663 |
+
"properties": {},
|
| 664 |
+
"type": "object"
|
| 665 |
+
},
|
| 666 |
+
"CloudRunService": {
|
| 667 |
+
"description": "Represents a Cloud Run service destination.",
|
| 668 |
+
"id": "CloudRunService",
|
| 669 |
+
"properties": {
|
| 670 |
+
"path": {
|
| 671 |
+
"description": "Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: \"/route\", \"route\", \"route/subroute\".",
|
| 672 |
+
"type": "string"
|
| 673 |
+
},
|
| 674 |
+
"region": {
|
| 675 |
+
"description": "Required. The region the Cloud Run service is deployed in.",
|
| 676 |
+
"type": "string"
|
| 677 |
+
},
|
| 678 |
+
"service": {
|
| 679 |
+
"description": "Required. The name of the Cloud run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project of the trigger object can be addressed.",
|
| 680 |
+
"type": "string"
|
| 681 |
+
}
|
| 682 |
+
},
|
| 683 |
+
"type": "object"
|
| 684 |
+
},
|
| 685 |
+
"Destination": {
|
| 686 |
+
"description": "Represents a target of an invocation over HTTP.",
|
| 687 |
+
"id": "Destination",
|
| 688 |
+
"properties": {
|
| 689 |
+
"cloudRunService": {
|
| 690 |
+
"$ref": "CloudRunService",
|
| 691 |
+
"description": "Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger."
|
| 692 |
+
}
|
| 693 |
+
},
|
| 694 |
+
"type": "object"
|
| 695 |
+
},
|
| 696 |
+
"Empty": {
|
| 697 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 698 |
+
"id": "Empty",
|
| 699 |
+
"properties": {},
|
| 700 |
+
"type": "object"
|
| 701 |
+
},
|
| 702 |
+
"Expr": {
|
| 703 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 704 |
+
"id": "Expr",
|
| 705 |
+
"properties": {
|
| 706 |
+
"description": {
|
| 707 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 708 |
+
"type": "string"
|
| 709 |
+
},
|
| 710 |
+
"expression": {
|
| 711 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 712 |
+
"type": "string"
|
| 713 |
+
},
|
| 714 |
+
"location": {
|
| 715 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 716 |
+
"type": "string"
|
| 717 |
+
},
|
| 718 |
+
"title": {
|
| 719 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 720 |
+
"type": "string"
|
| 721 |
+
}
|
| 722 |
+
},
|
| 723 |
+
"type": "object"
|
| 724 |
+
},
|
| 725 |
+
"ListLocationsResponse": {
|
| 726 |
+
"description": "The response message for Locations.ListLocations.",
|
| 727 |
+
"id": "ListLocationsResponse",
|
| 728 |
+
"properties": {
|
| 729 |
+
"locations": {
|
| 730 |
+
"description": "A list of locations that matches the specified filter in the request.",
|
| 731 |
+
"items": {
|
| 732 |
+
"$ref": "Location"
|
| 733 |
+
},
|
| 734 |
+
"type": "array"
|
| 735 |
+
},
|
| 736 |
+
"nextPageToken": {
|
| 737 |
+
"description": "The standard List next-page token.",
|
| 738 |
+
"type": "string"
|
| 739 |
+
}
|
| 740 |
+
},
|
| 741 |
+
"type": "object"
|
| 742 |
+
},
|
| 743 |
+
"ListOperationsResponse": {
|
| 744 |
+
"description": "The response message for Operations.ListOperations.",
|
| 745 |
+
"id": "ListOperationsResponse",
|
| 746 |
+
"properties": {
|
| 747 |
+
"nextPageToken": {
|
| 748 |
+
"description": "The standard List next-page token.",
|
| 749 |
+
"type": "string"
|
| 750 |
+
},
|
| 751 |
+
"operations": {
|
| 752 |
+
"description": "A list of operations that matches the specified filter in the request.",
|
| 753 |
+
"items": {
|
| 754 |
+
"$ref": "Operation"
|
| 755 |
+
},
|
| 756 |
+
"type": "array"
|
| 757 |
+
}
|
| 758 |
+
},
|
| 759 |
+
"type": "object"
|
| 760 |
+
},
|
| 761 |
+
"ListTriggersResponse": {
|
| 762 |
+
"description": "The response message for the ListTriggers method.",
|
| 763 |
+
"id": "ListTriggersResponse",
|
| 764 |
+
"properties": {
|
| 765 |
+
"nextPageToken": {
|
| 766 |
+
"description": "A page token that can be sent to ListTriggers to request the next page. If this is empty, then there are no more pages.",
|
| 767 |
+
"type": "string"
|
| 768 |
+
},
|
| 769 |
+
"triggers": {
|
| 770 |
+
"description": "The requested triggers, up to the number specified in `page_size`.",
|
| 771 |
+
"items": {
|
| 772 |
+
"$ref": "Trigger"
|
| 773 |
+
},
|
| 774 |
+
"type": "array"
|
| 775 |
+
},
|
| 776 |
+
"unreachable": {
|
| 777 |
+
"description": "Unreachable resources, if any.",
|
| 778 |
+
"items": {
|
| 779 |
+
"type": "string"
|
| 780 |
+
},
|
| 781 |
+
"type": "array"
|
| 782 |
+
}
|
| 783 |
+
},
|
| 784 |
+
"type": "object"
|
| 785 |
+
},
|
| 786 |
+
"Location": {
|
| 787 |
+
"description": "A resource that represents a Google Cloud location.",
|
| 788 |
+
"id": "Location",
|
| 789 |
+
"properties": {
|
| 790 |
+
"displayName": {
|
| 791 |
+
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
|
| 792 |
+
"type": "string"
|
| 793 |
+
},
|
| 794 |
+
"labels": {
|
| 795 |
+
"additionalProperties": {
|
| 796 |
+
"type": "string"
|
| 797 |
+
},
|
| 798 |
+
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
|
| 799 |
+
"type": "object"
|
| 800 |
+
},
|
| 801 |
+
"locationId": {
|
| 802 |
+
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
|
| 803 |
+
"type": "string"
|
| 804 |
+
},
|
| 805 |
+
"metadata": {
|
| 806 |
+
"additionalProperties": {
|
| 807 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 808 |
+
"type": "any"
|
| 809 |
+
},
|
| 810 |
+
"description": "Service-specific metadata. For example the available capacity at the given location.",
|
| 811 |
+
"type": "object"
|
| 812 |
+
},
|
| 813 |
+
"name": {
|
| 814 |
+
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
|
| 815 |
+
"type": "string"
|
| 816 |
+
}
|
| 817 |
+
},
|
| 818 |
+
"type": "object"
|
| 819 |
+
},
|
| 820 |
+
"MatchingCriteria": {
|
| 821 |
+
"description": "Matches events based on exact matches on the CloudEvents attributes.",
|
| 822 |
+
"id": "MatchingCriteria",
|
| 823 |
+
"properties": {
|
| 824 |
+
"attribute": {
|
| 825 |
+
"description": "Required. The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the 'type' attribute.",
|
| 826 |
+
"type": "string"
|
| 827 |
+
},
|
| 828 |
+
"value": {
|
| 829 |
+
"description": "Required. The value for the attribute.",
|
| 830 |
+
"type": "string"
|
| 831 |
+
}
|
| 832 |
+
},
|
| 833 |
+
"type": "object"
|
| 834 |
+
},
|
| 835 |
+
"Operation": {
|
| 836 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 837 |
+
"id": "Operation",
|
| 838 |
+
"properties": {
|
| 839 |
+
"done": {
|
| 840 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 841 |
+
"type": "boolean"
|
| 842 |
+
},
|
| 843 |
+
"error": {
|
| 844 |
+
"$ref": "Status",
|
| 845 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 846 |
+
},
|
| 847 |
+
"metadata": {
|
| 848 |
+
"additionalProperties": {
|
| 849 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 850 |
+
"type": "any"
|
| 851 |
+
},
|
| 852 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 853 |
+
"type": "object"
|
| 854 |
+
},
|
| 855 |
+
"name": {
|
| 856 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 857 |
+
"type": "string"
|
| 858 |
+
},
|
| 859 |
+
"response": {
|
| 860 |
+
"additionalProperties": {
|
| 861 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 862 |
+
"type": "any"
|
| 863 |
+
},
|
| 864 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 865 |
+
"type": "object"
|
| 866 |
+
}
|
| 867 |
+
},
|
| 868 |
+
"type": "object"
|
| 869 |
+
},
|
| 870 |
+
"OperationMetadata": {
|
| 871 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 872 |
+
"id": "OperationMetadata",
|
| 873 |
+
"properties": {
|
| 874 |
+
"apiVersion": {
|
| 875 |
+
"description": "Output only. API version used to start the operation.",
|
| 876 |
+
"readOnly": true,
|
| 877 |
+
"type": "string"
|
| 878 |
+
},
|
| 879 |
+
"createTime": {
|
| 880 |
+
"description": "Output only. The time the operation was created.",
|
| 881 |
+
"format": "google-datetime",
|
| 882 |
+
"readOnly": true,
|
| 883 |
+
"type": "string"
|
| 884 |
+
},
|
| 885 |
+
"endTime": {
|
| 886 |
+
"description": "Output only. The time the operation finished running.",
|
| 887 |
+
"format": "google-datetime",
|
| 888 |
+
"readOnly": true,
|
| 889 |
+
"type": "string"
|
| 890 |
+
},
|
| 891 |
+
"requestedCancellation": {
|
| 892 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 893 |
+
"readOnly": true,
|
| 894 |
+
"type": "boolean"
|
| 895 |
+
},
|
| 896 |
+
"statusMessage": {
|
| 897 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 898 |
+
"readOnly": true,
|
| 899 |
+
"type": "string"
|
| 900 |
+
},
|
| 901 |
+
"target": {
|
| 902 |
+
"description": "Output only. Server-defined resource path for the target of the operation.",
|
| 903 |
+
"readOnly": true,
|
| 904 |
+
"type": "string"
|
| 905 |
+
},
|
| 906 |
+
"verb": {
|
| 907 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 908 |
+
"readOnly": true,
|
| 909 |
+
"type": "string"
|
| 910 |
+
}
|
| 911 |
+
},
|
| 912 |
+
"type": "object"
|
| 913 |
+
},
|
| 914 |
+
"Policy": {
|
| 915 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 916 |
+
"id": "Policy",
|
| 917 |
+
"properties": {
|
| 918 |
+
"auditConfigs": {
|
| 919 |
+
"description": "Specifies cloud audit logging configuration for this policy.",
|
| 920 |
+
"items": {
|
| 921 |
+
"$ref": "AuditConfig"
|
| 922 |
+
},
|
| 923 |
+
"type": "array"
|
| 924 |
+
},
|
| 925 |
+
"bindings": {
|
| 926 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 927 |
+
"items": {
|
| 928 |
+
"$ref": "Binding"
|
| 929 |
+
},
|
| 930 |
+
"type": "array"
|
| 931 |
+
},
|
| 932 |
+
"etag": {
|
| 933 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 934 |
+
"format": "byte",
|
| 935 |
+
"type": "string"
|
| 936 |
+
},
|
| 937 |
+
"version": {
|
| 938 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 939 |
+
"format": "int32",
|
| 940 |
+
"type": "integer"
|
| 941 |
+
}
|
| 942 |
+
},
|
| 943 |
+
"type": "object"
|
| 944 |
+
},
|
| 945 |
+
"Pubsub": {
|
| 946 |
+
"description": "Represents a Pub/Sub transport.",
|
| 947 |
+
"id": "Pubsub",
|
| 948 |
+
"properties": {
|
| 949 |
+
"subscription": {
|
| 950 |
+
"description": "Output only. The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`.",
|
| 951 |
+
"readOnly": true,
|
| 952 |
+
"type": "string"
|
| 953 |
+
},
|
| 954 |
+
"topic": {
|
| 955 |
+
"description": "Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{PROJECT_ID}/topics/{TOPIC_NAME}`. You may set an existing topic for triggers of the type `google.cloud.pubsub.topic.v1.messagePublished` only. The topic you provide here will not be deleted by Eventarc at trigger deletion.",
|
| 956 |
+
"type": "string"
|
| 957 |
+
}
|
| 958 |
+
},
|
| 959 |
+
"type": "object"
|
| 960 |
+
},
|
| 961 |
+
"SetIamPolicyRequest": {
|
| 962 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 963 |
+
"id": "SetIamPolicyRequest",
|
| 964 |
+
"properties": {
|
| 965 |
+
"policy": {
|
| 966 |
+
"$ref": "Policy",
|
| 967 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 968 |
+
},
|
| 969 |
+
"updateMask": {
|
| 970 |
+
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
|
| 971 |
+
"format": "google-fieldmask",
|
| 972 |
+
"type": "string"
|
| 973 |
+
}
|
| 974 |
+
},
|
| 975 |
+
"type": "object"
|
| 976 |
+
},
|
| 977 |
+
"Status": {
|
| 978 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 979 |
+
"id": "Status",
|
| 980 |
+
"properties": {
|
| 981 |
+
"code": {
|
| 982 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 983 |
+
"format": "int32",
|
| 984 |
+
"type": "integer"
|
| 985 |
+
},
|
| 986 |
+
"details": {
|
| 987 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 988 |
+
"items": {
|
| 989 |
+
"additionalProperties": {
|
| 990 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 991 |
+
"type": "any"
|
| 992 |
+
},
|
| 993 |
+
"type": "object"
|
| 994 |
+
},
|
| 995 |
+
"type": "array"
|
| 996 |
+
},
|
| 997 |
+
"message": {
|
| 998 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 999 |
+
"type": "string"
|
| 1000 |
+
}
|
| 1001 |
+
},
|
| 1002 |
+
"type": "object"
|
| 1003 |
+
},
|
| 1004 |
+
"TestIamPermissionsRequest": {
|
| 1005 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 1006 |
+
"id": "TestIamPermissionsRequest",
|
| 1007 |
+
"properties": {
|
| 1008 |
+
"permissions": {
|
| 1009 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 1010 |
+
"items": {
|
| 1011 |
+
"type": "string"
|
| 1012 |
+
},
|
| 1013 |
+
"type": "array"
|
| 1014 |
+
}
|
| 1015 |
+
},
|
| 1016 |
+
"type": "object"
|
| 1017 |
+
},
|
| 1018 |
+
"TestIamPermissionsResponse": {
|
| 1019 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 1020 |
+
"id": "TestIamPermissionsResponse",
|
| 1021 |
+
"properties": {
|
| 1022 |
+
"permissions": {
|
| 1023 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 1024 |
+
"items": {
|
| 1025 |
+
"type": "string"
|
| 1026 |
+
},
|
| 1027 |
+
"type": "array"
|
| 1028 |
+
}
|
| 1029 |
+
},
|
| 1030 |
+
"type": "object"
|
| 1031 |
+
},
|
| 1032 |
+
"Transport": {
|
| 1033 |
+
"description": "Represents the transport intermediaries created for the trigger in order to deliver events.",
|
| 1034 |
+
"id": "Transport",
|
| 1035 |
+
"properties": {
|
| 1036 |
+
"pubsub": {
|
| 1037 |
+
"$ref": "Pubsub",
|
| 1038 |
+
"description": "The Pub/Sub topic and subscription used by Eventarc as delivery intermediary."
|
| 1039 |
+
}
|
| 1040 |
+
},
|
| 1041 |
+
"type": "object"
|
| 1042 |
+
},
|
| 1043 |
+
"Trigger": {
|
| 1044 |
+
"description": "A representation of the trigger resource.",
|
| 1045 |
+
"id": "Trigger",
|
| 1046 |
+
"properties": {
|
| 1047 |
+
"createTime": {
|
| 1048 |
+
"description": "Output only. The creation time.",
|
| 1049 |
+
"format": "google-datetime",
|
| 1050 |
+
"readOnly": true,
|
| 1051 |
+
"type": "string"
|
| 1052 |
+
},
|
| 1053 |
+
"destination": {
|
| 1054 |
+
"$ref": "Destination",
|
| 1055 |
+
"description": "Required. Destination specifies where the events should be sent to."
|
| 1056 |
+
},
|
| 1057 |
+
"etag": {
|
| 1058 |
+
"description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.",
|
| 1059 |
+
"readOnly": true,
|
| 1060 |
+
"type": "string"
|
| 1061 |
+
},
|
| 1062 |
+
"labels": {
|
| 1063 |
+
"additionalProperties": {
|
| 1064 |
+
"type": "string"
|
| 1065 |
+
},
|
| 1066 |
+
"description": "Optional. User labels attached to the triggers that can be used to group resources.",
|
| 1067 |
+
"type": "object"
|
| 1068 |
+
},
|
| 1069 |
+
"matchingCriteria": {
|
| 1070 |
+
"description": "Required. Unordered list. The criteria by which events are filtered. Only events that match with this criteria will be sent to the destination.",
|
| 1071 |
+
"items": {
|
| 1072 |
+
"$ref": "MatchingCriteria"
|
| 1073 |
+
},
|
| 1074 |
+
"type": "array"
|
| 1075 |
+
},
|
| 1076 |
+
"name": {
|
| 1077 |
+
"description": "Required. The resource name of the trigger. Must be unique within the location on the project and must in `projects/{project}/locations/{location}/triggers/{trigger}` format.",
|
| 1078 |
+
"type": "string"
|
| 1079 |
+
},
|
| 1080 |
+
"serviceAccount": {
|
| 1081 |
+
"description": "Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have `iam.serviceAccounts.actAs` permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have 'eventarc.events.receiveAuditLogV1Written' permission.",
|
| 1082 |
+
"type": "string"
|
| 1083 |
+
},
|
| 1084 |
+
"transport": {
|
| 1085 |
+
"$ref": "Transport",
|
| 1086 |
+
"description": "Output only. In order to deliver messages, Eventarc may use other Google Cloud products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.",
|
| 1087 |
+
"readOnly": true
|
| 1088 |
+
},
|
| 1089 |
+
"updateTime": {
|
| 1090 |
+
"description": "Output only. The last-modified time.",
|
| 1091 |
+
"format": "google-datetime",
|
| 1092 |
+
"readOnly": true,
|
| 1093 |
+
"type": "string"
|
| 1094 |
+
}
|
| 1095 |
+
},
|
| 1096 |
+
"type": "object"
|
| 1097 |
+
}
|
| 1098 |
+
},
|
| 1099 |
+
"servicePath": "",
|
| 1100 |
+
"title": "Eventarc API",
|
| 1101 |
+
"version": "v1beta1",
|
| 1102 |
+
"version_module": true
|
| 1103 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json
ADDED
|
@@ -0,0 +1,1293 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud Platform data"
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/compute": {
|
| 9 |
+
"description": "View and manage your Google Compute Engine resources"
|
| 10 |
+
},
|
| 11 |
+
"https://www.googleapis.com/auth/genomics": {
|
| 12 |
+
"description": "View and manage Genomics data"
|
| 13 |
+
}
|
| 14 |
+
}
|
| 15 |
+
}
|
| 16 |
+
},
|
| 17 |
+
"basePath": "",
|
| 18 |
+
"baseUrl": "https://genomics.googleapis.com/",
|
| 19 |
+
"batchPath": "batch",
|
| 20 |
+
"description": "Uploads, processes, queries, and searches Genomics data in the cloud.",
|
| 21 |
+
"discoveryVersion": "v1",
|
| 22 |
+
"documentationLink": "https://cloud.google.com/genomics",
|
| 23 |
+
"fullyEncodeReservedExpansion": true,
|
| 24 |
+
"icons": {
|
| 25 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 26 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 27 |
+
},
|
| 28 |
+
"id": "genomics:v1alpha2",
|
| 29 |
+
"kind": "discovery#restDescription",
|
| 30 |
+
"mtlsRootUrl": "https://genomics.mtls.googleapis.com/",
|
| 31 |
+
"name": "genomics",
|
| 32 |
+
"ownerDomain": "google.com",
|
| 33 |
+
"ownerName": "Google",
|
| 34 |
+
"parameters": {
|
| 35 |
+
"$.xgafv": {
|
| 36 |
+
"description": "V1 error format.",
|
| 37 |
+
"enum": [
|
| 38 |
+
"1",
|
| 39 |
+
"2"
|
| 40 |
+
],
|
| 41 |
+
"enumDescriptions": [
|
| 42 |
+
"v1 error format",
|
| 43 |
+
"v2 error format"
|
| 44 |
+
],
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"access_token": {
|
| 49 |
+
"description": "OAuth access token.",
|
| 50 |
+
"location": "query",
|
| 51 |
+
"type": "string"
|
| 52 |
+
},
|
| 53 |
+
"alt": {
|
| 54 |
+
"default": "json",
|
| 55 |
+
"description": "Data format for response.",
|
| 56 |
+
"enum": [
|
| 57 |
+
"json",
|
| 58 |
+
"media",
|
| 59 |
+
"proto"
|
| 60 |
+
],
|
| 61 |
+
"enumDescriptions": [
|
| 62 |
+
"Responses with Content-Type of application/json",
|
| 63 |
+
"Media download with context-dependent Content-Type",
|
| 64 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 65 |
+
],
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"callback": {
|
| 70 |
+
"description": "JSONP",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"fields": {
|
| 75 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"key": {
|
| 80 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"oauth_token": {
|
| 85 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 86 |
+
"location": "query",
|
| 87 |
+
"type": "string"
|
| 88 |
+
},
|
| 89 |
+
"prettyPrint": {
|
| 90 |
+
"default": "true",
|
| 91 |
+
"description": "Returns response with indentations and line breaks.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "boolean"
|
| 94 |
+
},
|
| 95 |
+
"quotaUser": {
|
| 96 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"uploadType": {
|
| 101 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
},
|
| 105 |
+
"upload_protocol": {
|
| 106 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 107 |
+
"location": "query",
|
| 108 |
+
"type": "string"
|
| 109 |
+
}
|
| 110 |
+
},
|
| 111 |
+
"protocol": "rest",
|
| 112 |
+
"resources": {
|
| 113 |
+
"operations": {
|
| 114 |
+
"methods": {
|
| 115 |
+
"cancel": {
|
| 116 |
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`",
|
| 117 |
+
"flatPath": "v1alpha2/operations/{operationsId}:cancel",
|
| 118 |
+
"httpMethod": "POST",
|
| 119 |
+
"id": "genomics.operations.cancel",
|
| 120 |
+
"parameterOrder": [
|
| 121 |
+
"name"
|
| 122 |
+
],
|
| 123 |
+
"parameters": {
|
| 124 |
+
"name": {
|
| 125 |
+
"description": "The name of the operation resource to be cancelled.",
|
| 126 |
+
"location": "path",
|
| 127 |
+
"pattern": "^operations/.*$",
|
| 128 |
+
"required": true,
|
| 129 |
+
"type": "string"
|
| 130 |
+
}
|
| 131 |
+
},
|
| 132 |
+
"path": "v1alpha2/{+name}:cancel",
|
| 133 |
+
"request": {
|
| 134 |
+
"$ref": "CancelOperationRequest"
|
| 135 |
+
},
|
| 136 |
+
"response": {
|
| 137 |
+
"$ref": "Empty"
|
| 138 |
+
},
|
| 139 |
+
"scopes": [
|
| 140 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 141 |
+
"https://www.googleapis.com/auth/genomics"
|
| 142 |
+
]
|
| 143 |
+
},
|
| 144 |
+
"get": {
|
| 145 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`",
|
| 146 |
+
"flatPath": "v1alpha2/operations/{operationsId}",
|
| 147 |
+
"httpMethod": "GET",
|
| 148 |
+
"id": "genomics.operations.get",
|
| 149 |
+
"parameterOrder": [
|
| 150 |
+
"name"
|
| 151 |
+
],
|
| 152 |
+
"parameters": {
|
| 153 |
+
"name": {
|
| 154 |
+
"description": "The name of the operation resource.",
|
| 155 |
+
"location": "path",
|
| 156 |
+
"pattern": "^operations/.*$",
|
| 157 |
+
"required": true,
|
| 158 |
+
"type": "string"
|
| 159 |
+
}
|
| 160 |
+
},
|
| 161 |
+
"path": "v1alpha2/{+name}",
|
| 162 |
+
"response": {
|
| 163 |
+
"$ref": "Operation"
|
| 164 |
+
},
|
| 165 |
+
"scopes": [
|
| 166 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 167 |
+
"https://www.googleapis.com/auth/genomics"
|
| 168 |
+
]
|
| 169 |
+
},
|
| 170 |
+
"list": {
|
| 171 |
+
"description": "Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`",
|
| 172 |
+
"flatPath": "v1alpha2/operations",
|
| 173 |
+
"httpMethod": "GET",
|
| 174 |
+
"id": "genomics.operations.list",
|
| 175 |
+
"parameterOrder": [
|
| 176 |
+
"name"
|
| 177 |
+
],
|
| 178 |
+
"parameters": {
|
| 179 |
+
"filter": {
|
| 180 |
+
"description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`",
|
| 181 |
+
"location": "query",
|
| 182 |
+
"type": "string"
|
| 183 |
+
},
|
| 184 |
+
"name": {
|
| 185 |
+
"description": "The name of the operation's parent resource.",
|
| 186 |
+
"location": "path",
|
| 187 |
+
"pattern": "^operations$",
|
| 188 |
+
"required": true,
|
| 189 |
+
"type": "string"
|
| 190 |
+
},
|
| 191 |
+
"pageSize": {
|
| 192 |
+
"description": "The maximum number of results to return. The maximum value is 256.",
|
| 193 |
+
"format": "int32",
|
| 194 |
+
"location": "query",
|
| 195 |
+
"type": "integer"
|
| 196 |
+
},
|
| 197 |
+
"pageToken": {
|
| 198 |
+
"description": "The standard list page token.",
|
| 199 |
+
"location": "query",
|
| 200 |
+
"type": "string"
|
| 201 |
+
}
|
| 202 |
+
},
|
| 203 |
+
"path": "v1alpha2/{+name}",
|
| 204 |
+
"response": {
|
| 205 |
+
"$ref": "ListOperationsResponse"
|
| 206 |
+
},
|
| 207 |
+
"scopes": [
|
| 208 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 209 |
+
"https://www.googleapis.com/auth/genomics"
|
| 210 |
+
]
|
| 211 |
+
}
|
| 212 |
+
}
|
| 213 |
+
},
|
| 214 |
+
"pipelines": {
|
| 215 |
+
"methods": {
|
| 216 |
+
"create": {
|
| 217 |
+
"description": "Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.",
|
| 218 |
+
"flatPath": "v1alpha2/pipelines",
|
| 219 |
+
"httpMethod": "POST",
|
| 220 |
+
"id": "genomics.pipelines.create",
|
| 221 |
+
"parameterOrder": [],
|
| 222 |
+
"parameters": {},
|
| 223 |
+
"path": "v1alpha2/pipelines",
|
| 224 |
+
"request": {
|
| 225 |
+
"$ref": "Pipeline"
|
| 226 |
+
},
|
| 227 |
+
"response": {
|
| 228 |
+
"$ref": "Pipeline"
|
| 229 |
+
},
|
| 230 |
+
"scopes": [
|
| 231 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 232 |
+
"https://www.googleapis.com/auth/genomics"
|
| 233 |
+
]
|
| 234 |
+
},
|
| 235 |
+
"delete": {
|
| 236 |
+
"description": "Deletes a pipeline based on ID. Caller must have WRITE permission to the project.",
|
| 237 |
+
"flatPath": "v1alpha2/pipelines/{pipelineId}",
|
| 238 |
+
"httpMethod": "DELETE",
|
| 239 |
+
"id": "genomics.pipelines.delete",
|
| 240 |
+
"parameterOrder": [
|
| 241 |
+
"pipelineId"
|
| 242 |
+
],
|
| 243 |
+
"parameters": {
|
| 244 |
+
"pipelineId": {
|
| 245 |
+
"description": "Caller must have WRITE access to the project in which this pipeline is defined.",
|
| 246 |
+
"location": "path",
|
| 247 |
+
"required": true,
|
| 248 |
+
"type": "string"
|
| 249 |
+
}
|
| 250 |
+
},
|
| 251 |
+
"path": "v1alpha2/pipelines/{pipelineId}",
|
| 252 |
+
"response": {
|
| 253 |
+
"$ref": "Empty"
|
| 254 |
+
},
|
| 255 |
+
"scopes": [
|
| 256 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 257 |
+
"https://www.googleapis.com/auth/genomics"
|
| 258 |
+
]
|
| 259 |
+
},
|
| 260 |
+
"get": {
|
| 261 |
+
"description": "Retrieves a pipeline based on ID. Caller must have READ permission to the project.",
|
| 262 |
+
"flatPath": "v1alpha2/pipelines/{pipelineId}",
|
| 263 |
+
"httpMethod": "GET",
|
| 264 |
+
"id": "genomics.pipelines.get",
|
| 265 |
+
"parameterOrder": [
|
| 266 |
+
"pipelineId"
|
| 267 |
+
],
|
| 268 |
+
"parameters": {
|
| 269 |
+
"pipelineId": {
|
| 270 |
+
"description": "Caller must have READ access to the project in which this pipeline is defined.",
|
| 271 |
+
"location": "path",
|
| 272 |
+
"required": true,
|
| 273 |
+
"type": "string"
|
| 274 |
+
}
|
| 275 |
+
},
|
| 276 |
+
"path": "v1alpha2/pipelines/{pipelineId}",
|
| 277 |
+
"response": {
|
| 278 |
+
"$ref": "Pipeline"
|
| 279 |
+
},
|
| 280 |
+
"scopes": [
|
| 281 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 282 |
+
"https://www.googleapis.com/auth/genomics"
|
| 283 |
+
]
|
| 284 |
+
},
|
| 285 |
+
"getControllerConfig": {
|
| 286 |
+
"description": "Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.",
|
| 287 |
+
"flatPath": "v1alpha2/pipelines:getControllerConfig",
|
| 288 |
+
"httpMethod": "GET",
|
| 289 |
+
"id": "genomics.pipelines.getControllerConfig",
|
| 290 |
+
"parameterOrder": [],
|
| 291 |
+
"parameters": {
|
| 292 |
+
"operationId": {
|
| 293 |
+
"description": "The operation to retrieve controller configuration for.",
|
| 294 |
+
"location": "query",
|
| 295 |
+
"type": "string"
|
| 296 |
+
},
|
| 297 |
+
"validationToken": {
|
| 298 |
+
"format": "uint64",
|
| 299 |
+
"location": "query",
|
| 300 |
+
"type": "string"
|
| 301 |
+
}
|
| 302 |
+
},
|
| 303 |
+
"path": "v1alpha2/pipelines:getControllerConfig",
|
| 304 |
+
"response": {
|
| 305 |
+
"$ref": "ControllerConfig"
|
| 306 |
+
},
|
| 307 |
+
"scopes": [
|
| 308 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 309 |
+
"https://www.googleapis.com/auth/genomics"
|
| 310 |
+
]
|
| 311 |
+
},
|
| 312 |
+
"list": {
|
| 313 |
+
"description": "Lists pipelines. Caller must have READ permission to the project.",
|
| 314 |
+
"flatPath": "v1alpha2/pipelines",
|
| 315 |
+
"httpMethod": "GET",
|
| 316 |
+
"id": "genomics.pipelines.list",
|
| 317 |
+
"parameterOrder": [],
|
| 318 |
+
"parameters": {
|
| 319 |
+
"namePrefix": {
|
| 320 |
+
"description": "Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.",
|
| 321 |
+
"location": "query",
|
| 322 |
+
"type": "string"
|
| 323 |
+
},
|
| 324 |
+
"pageSize": {
|
| 325 |
+
"description": "Number of pipelines to return at once. Defaults to 256, and max is 2048.",
|
| 326 |
+
"format": "int32",
|
| 327 |
+
"location": "query",
|
| 328 |
+
"type": "integer"
|
| 329 |
+
},
|
| 330 |
+
"pageToken": {
|
| 331 |
+
"description": "Token to use to indicate where to start getting results. If unspecified, returns the first page of results.",
|
| 332 |
+
"location": "query",
|
| 333 |
+
"type": "string"
|
| 334 |
+
},
|
| 335 |
+
"projectId": {
|
| 336 |
+
"description": "Required. The name of the project to search for pipelines. Caller must have READ access to this project.",
|
| 337 |
+
"location": "query",
|
| 338 |
+
"type": "string"
|
| 339 |
+
}
|
| 340 |
+
},
|
| 341 |
+
"path": "v1alpha2/pipelines",
|
| 342 |
+
"response": {
|
| 343 |
+
"$ref": "ListPipelinesResponse"
|
| 344 |
+
},
|
| 345 |
+
"scopes": [
|
| 346 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 347 |
+
"https://www.googleapis.com/auth/genomics"
|
| 348 |
+
]
|
| 349 |
+
},
|
| 350 |
+
"run": {
|
| 351 |
+
"description": "Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled.",
|
| 352 |
+
"flatPath": "v1alpha2/pipelines:run",
|
| 353 |
+
"httpMethod": "POST",
|
| 354 |
+
"id": "genomics.pipelines.run",
|
| 355 |
+
"parameterOrder": [],
|
| 356 |
+
"parameters": {},
|
| 357 |
+
"path": "v1alpha2/pipelines:run",
|
| 358 |
+
"request": {
|
| 359 |
+
"$ref": "RunPipelineRequest"
|
| 360 |
+
},
|
| 361 |
+
"response": {
|
| 362 |
+
"$ref": "Operation"
|
| 363 |
+
},
|
| 364 |
+
"scopes": [
|
| 365 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 366 |
+
"https://www.googleapis.com/auth/compute",
|
| 367 |
+
"https://www.googleapis.com/auth/genomics"
|
| 368 |
+
]
|
| 369 |
+
},
|
| 370 |
+
"setOperationStatus": {
|
| 371 |
+
"description": "Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.",
|
| 372 |
+
"flatPath": "v1alpha2/pipelines:setOperationStatus",
|
| 373 |
+
"httpMethod": "PUT",
|
| 374 |
+
"id": "genomics.pipelines.setOperationStatus",
|
| 375 |
+
"parameterOrder": [],
|
| 376 |
+
"parameters": {},
|
| 377 |
+
"path": "v1alpha2/pipelines:setOperationStatus",
|
| 378 |
+
"request": {
|
| 379 |
+
"$ref": "SetOperationStatusRequest"
|
| 380 |
+
},
|
| 381 |
+
"response": {
|
| 382 |
+
"$ref": "Empty"
|
| 383 |
+
},
|
| 384 |
+
"scopes": [
|
| 385 |
+
"https://www.googleapis.com/auth/cloud-platform",
|
| 386 |
+
"https://www.googleapis.com/auth/genomics"
|
| 387 |
+
]
|
| 388 |
+
}
|
| 389 |
+
}
|
| 390 |
+
}
|
| 391 |
+
},
|
| 392 |
+
"revision": "20210503",
|
| 393 |
+
"rootUrl": "https://genomics.googleapis.com/",
|
| 394 |
+
"schemas": {
|
| 395 |
+
"CancelOperationRequest": {
|
| 396 |
+
"description": "The request message for Operations.CancelOperation.",
|
| 397 |
+
"id": "CancelOperationRequest",
|
| 398 |
+
"properties": {},
|
| 399 |
+
"type": "object"
|
| 400 |
+
},
|
| 401 |
+
"ComputeEngine": {
|
| 402 |
+
"description": "Describes a Compute Engine resource that is being managed by a running pipeline.",
|
| 403 |
+
"id": "ComputeEngine",
|
| 404 |
+
"properties": {
|
| 405 |
+
"diskNames": {
|
| 406 |
+
"description": "The names of the disks that were created for this pipeline.",
|
| 407 |
+
"items": {
|
| 408 |
+
"type": "string"
|
| 409 |
+
},
|
| 410 |
+
"type": "array"
|
| 411 |
+
},
|
| 412 |
+
"instanceName": {
|
| 413 |
+
"description": "The instance on which the operation is running.",
|
| 414 |
+
"type": "string"
|
| 415 |
+
},
|
| 416 |
+
"machineType": {
|
| 417 |
+
"description": "The machine type of the instance.",
|
| 418 |
+
"type": "string"
|
| 419 |
+
},
|
| 420 |
+
"zone": {
|
| 421 |
+
"description": "The availability zone in which the instance resides.",
|
| 422 |
+
"type": "string"
|
| 423 |
+
}
|
| 424 |
+
},
|
| 425 |
+
"type": "object"
|
| 426 |
+
},
|
| 427 |
+
"ContainerKilledEvent": {
|
| 428 |
+
"description": "An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.",
|
| 429 |
+
"id": "ContainerKilledEvent",
|
| 430 |
+
"properties": {
|
| 431 |
+
"actionId": {
|
| 432 |
+
"description": "The numeric ID of the action that started the container.",
|
| 433 |
+
"format": "int32",
|
| 434 |
+
"type": "integer"
|
| 435 |
+
}
|
| 436 |
+
},
|
| 437 |
+
"type": "object"
|
| 438 |
+
},
|
| 439 |
+
"ContainerStartedEvent": {
|
| 440 |
+
"description": "An event generated when a container starts.",
|
| 441 |
+
"id": "ContainerStartedEvent",
|
| 442 |
+
"properties": {
|
| 443 |
+
"actionId": {
|
| 444 |
+
"description": "The numeric ID of the action that started this container.",
|
| 445 |
+
"format": "int32",
|
| 446 |
+
"type": "integer"
|
| 447 |
+
},
|
| 448 |
+
"ipAddress": {
|
| 449 |
+
"description": "The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist.",
|
| 450 |
+
"type": "string"
|
| 451 |
+
},
|
| 452 |
+
"portMappings": {
|
| 453 |
+
"additionalProperties": {
|
| 454 |
+
"format": "int32",
|
| 455 |
+
"type": "integer"
|
| 456 |
+
},
|
| 457 |
+
"description": "The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition.",
|
| 458 |
+
"type": "object"
|
| 459 |
+
}
|
| 460 |
+
},
|
| 461 |
+
"type": "object"
|
| 462 |
+
},
|
| 463 |
+
"ContainerStoppedEvent": {
|
| 464 |
+
"description": "An event generated when a container exits.",
|
| 465 |
+
"id": "ContainerStoppedEvent",
|
| 466 |
+
"properties": {
|
| 467 |
+
"actionId": {
|
| 468 |
+
"description": "The numeric ID of the action that started this container.",
|
| 469 |
+
"format": "int32",
|
| 470 |
+
"type": "integer"
|
| 471 |
+
},
|
| 472 |
+
"exitStatus": {
|
| 473 |
+
"description": "The exit status of the container.",
|
| 474 |
+
"format": "int32",
|
| 475 |
+
"type": "integer"
|
| 476 |
+
},
|
| 477 |
+
"stderr": {
|
| 478 |
+
"description": "The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere.",
|
| 479 |
+
"type": "string"
|
| 480 |
+
}
|
| 481 |
+
},
|
| 482 |
+
"type": "object"
|
| 483 |
+
},
|
| 484 |
+
"ControllerConfig": {
|
| 485 |
+
"description": "Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.",
|
| 486 |
+
"id": "ControllerConfig",
|
| 487 |
+
"properties": {
|
| 488 |
+
"cmd": {
|
| 489 |
+
"type": "string"
|
| 490 |
+
},
|
| 491 |
+
"disks": {
|
| 492 |
+
"additionalProperties": {
|
| 493 |
+
"type": "string"
|
| 494 |
+
},
|
| 495 |
+
"type": "object"
|
| 496 |
+
},
|
| 497 |
+
"gcsLogPath": {
|
| 498 |
+
"type": "string"
|
| 499 |
+
},
|
| 500 |
+
"gcsSinks": {
|
| 501 |
+
"additionalProperties": {
|
| 502 |
+
"$ref": "RepeatedString"
|
| 503 |
+
},
|
| 504 |
+
"type": "object"
|
| 505 |
+
},
|
| 506 |
+
"gcsSources": {
|
| 507 |
+
"additionalProperties": {
|
| 508 |
+
"$ref": "RepeatedString"
|
| 509 |
+
},
|
| 510 |
+
"type": "object"
|
| 511 |
+
},
|
| 512 |
+
"image": {
|
| 513 |
+
"type": "string"
|
| 514 |
+
},
|
| 515 |
+
"machineType": {
|
| 516 |
+
"type": "string"
|
| 517 |
+
},
|
| 518 |
+
"vars": {
|
| 519 |
+
"additionalProperties": {
|
| 520 |
+
"type": "string"
|
| 521 |
+
},
|
| 522 |
+
"type": "object"
|
| 523 |
+
}
|
| 524 |
+
},
|
| 525 |
+
"type": "object"
|
| 526 |
+
},
|
| 527 |
+
"DelayedEvent": {
|
| 528 |
+
"description": "An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.",
|
| 529 |
+
"id": "DelayedEvent",
|
| 530 |
+
"properties": {
|
| 531 |
+
"cause": {
|
| 532 |
+
"description": "A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine).",
|
| 533 |
+
"type": "string"
|
| 534 |
+
},
|
| 535 |
+
"metrics": {
|
| 536 |
+
"description": "If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present.",
|
| 537 |
+
"items": {
|
| 538 |
+
"type": "string"
|
| 539 |
+
},
|
| 540 |
+
"type": "array"
|
| 541 |
+
}
|
| 542 |
+
},
|
| 543 |
+
"type": "object"
|
| 544 |
+
},
|
| 545 |
+
"Disk": {
|
| 546 |
+
"description": "A Google Compute Engine disk resource specification.",
|
| 547 |
+
"id": "Disk",
|
| 548 |
+
"properties": {
|
| 549 |
+
"autoDelete": {
|
| 550 |
+
"description": "Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.",
|
| 551 |
+
"type": "boolean"
|
| 552 |
+
},
|
| 553 |
+
"mountPoint": {
|
| 554 |
+
"description": "Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.",
|
| 555 |
+
"type": "string"
|
| 556 |
+
},
|
| 557 |
+
"name": {
|
| 558 |
+
"description": "Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name \"boot\" is reserved for system use.",
|
| 559 |
+
"type": "string"
|
| 560 |
+
},
|
| 561 |
+
"readOnly": {
|
| 562 |
+
"description": "Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.",
|
| 563 |
+
"type": "boolean"
|
| 564 |
+
},
|
| 565 |
+
"sizeGb": {
|
| 566 |
+
"description": "The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.",
|
| 567 |
+
"format": "int32",
|
| 568 |
+
"type": "integer"
|
| 569 |
+
},
|
| 570 |
+
"source": {
|
| 571 |
+
"description": "The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.",
|
| 572 |
+
"type": "string"
|
| 573 |
+
},
|
| 574 |
+
"type": {
|
| 575 |
+
"description": "Required. The type of the disk to create.",
|
| 576 |
+
"enum": [
|
| 577 |
+
"TYPE_UNSPECIFIED",
|
| 578 |
+
"PERSISTENT_HDD",
|
| 579 |
+
"PERSISTENT_SSD",
|
| 580 |
+
"LOCAL_SSD"
|
| 581 |
+
],
|
| 582 |
+
"enumDescriptions": [
|
| 583 |
+
"Default disk type. Use one of the other options below.",
|
| 584 |
+
"Specifies a Google Compute Engine persistent hard disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.",
|
| 585 |
+
"Specifies a Google Compute Engine persistent solid-state disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.",
|
| 586 |
+
"Specifies a Google Compute Engine local SSD. See https://cloud.google.com/compute/docs/disks/local-ssd for details."
|
| 587 |
+
],
|
| 588 |
+
"type": "string"
|
| 589 |
+
}
|
| 590 |
+
},
|
| 591 |
+
"type": "object"
|
| 592 |
+
},
|
| 593 |
+
"DockerExecutor": {
|
| 594 |
+
"description": "The Docker execuctor specification.",
|
| 595 |
+
"id": "DockerExecutor",
|
| 596 |
+
"properties": {
|
| 597 |
+
"cmd": {
|
| 598 |
+
"description": "Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.",
|
| 599 |
+
"type": "string"
|
| 600 |
+
},
|
| 601 |
+
"imageName": {
|
| 602 |
+
"description": "Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.",
|
| 603 |
+
"type": "string"
|
| 604 |
+
}
|
| 605 |
+
},
|
| 606 |
+
"type": "object"
|
| 607 |
+
},
|
| 608 |
+
"Empty": {
|
| 609 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
|
| 610 |
+
"id": "Empty",
|
| 611 |
+
"properties": {},
|
| 612 |
+
"type": "object"
|
| 613 |
+
},
|
| 614 |
+
"Event": {
|
| 615 |
+
"description": "Carries information about events that occur during pipeline execution.",
|
| 616 |
+
"id": "Event",
|
| 617 |
+
"properties": {
|
| 618 |
+
"description": {
|
| 619 |
+
"description": "A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field.",
|
| 620 |
+
"type": "string"
|
| 621 |
+
},
|
| 622 |
+
"details": {
|
| 623 |
+
"additionalProperties": {
|
| 624 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 625 |
+
"type": "any"
|
| 626 |
+
},
|
| 627 |
+
"description": "Machine-readable details about the event.",
|
| 628 |
+
"type": "object"
|
| 629 |
+
},
|
| 630 |
+
"timestamp": {
|
| 631 |
+
"description": "The time at which the event occurred.",
|
| 632 |
+
"format": "google-datetime",
|
| 633 |
+
"type": "string"
|
| 634 |
+
}
|
| 635 |
+
},
|
| 636 |
+
"type": "object"
|
| 637 |
+
},
|
| 638 |
+
"FailedEvent": {
|
| 639 |
+
"description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.",
|
| 640 |
+
"id": "FailedEvent",
|
| 641 |
+
"properties": {
|
| 642 |
+
"cause": {
|
| 643 |
+
"description": "The human-readable description of the cause of the failure.",
|
| 644 |
+
"type": "string"
|
| 645 |
+
},
|
| 646 |
+
"code": {
|
| 647 |
+
"description": "The Google standard error code that best describes this failure.",
|
| 648 |
+
"enum": [
|
| 649 |
+
"OK",
|
| 650 |
+
"CANCELLED",
|
| 651 |
+
"UNKNOWN",
|
| 652 |
+
"INVALID_ARGUMENT",
|
| 653 |
+
"DEADLINE_EXCEEDED",
|
| 654 |
+
"NOT_FOUND",
|
| 655 |
+
"ALREADY_EXISTS",
|
| 656 |
+
"PERMISSION_DENIED",
|
| 657 |
+
"UNAUTHENTICATED",
|
| 658 |
+
"RESOURCE_EXHAUSTED",
|
| 659 |
+
"FAILED_PRECONDITION",
|
| 660 |
+
"ABORTED",
|
| 661 |
+
"OUT_OF_RANGE",
|
| 662 |
+
"UNIMPLEMENTED",
|
| 663 |
+
"INTERNAL",
|
| 664 |
+
"UNAVAILABLE",
|
| 665 |
+
"DATA_LOSS"
|
| 666 |
+
],
|
| 667 |
+
"enumDescriptions": [
|
| 668 |
+
"Not an error; returned on success HTTP Mapping: 200 OK",
|
| 669 |
+
"The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
|
| 670 |
+
"Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
|
| 671 |
+
"The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
|
| 672 |
+
"The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
|
| 673 |
+
"Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
|
| 674 |
+
"The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
|
| 675 |
+
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
|
| 676 |
+
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
|
| 677 |
+
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
|
| 678 |
+
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
|
| 679 |
+
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
|
| 680 |
+
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
|
| 681 |
+
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
|
| 682 |
+
"Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
|
| 683 |
+
"The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
|
| 684 |
+
"Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
|
| 685 |
+
],
|
| 686 |
+
"type": "string"
|
| 687 |
+
}
|
| 688 |
+
},
|
| 689 |
+
"type": "object"
|
| 690 |
+
},
|
| 691 |
+
"ListOperationsResponse": {
|
| 692 |
+
"description": "The response message for Operations.ListOperations.",
|
| 693 |
+
"id": "ListOperationsResponse",
|
| 694 |
+
"properties": {
|
| 695 |
+
"nextPageToken": {
|
| 696 |
+
"description": "The standard List next-page token.",
|
| 697 |
+
"type": "string"
|
| 698 |
+
},
|
| 699 |
+
"operations": {
|
| 700 |
+
"description": "A list of operations that matches the specified filter in the request.",
|
| 701 |
+
"items": {
|
| 702 |
+
"$ref": "Operation"
|
| 703 |
+
},
|
| 704 |
+
"type": "array"
|
| 705 |
+
}
|
| 706 |
+
},
|
| 707 |
+
"type": "object"
|
| 708 |
+
},
|
| 709 |
+
"ListPipelinesResponse": {
|
| 710 |
+
"description": "The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.",
|
| 711 |
+
"id": "ListPipelinesResponse",
|
| 712 |
+
"properties": {
|
| 713 |
+
"nextPageToken": {
|
| 714 |
+
"description": "The token to use to get the next page of results.",
|
| 715 |
+
"type": "string"
|
| 716 |
+
},
|
| 717 |
+
"pipelines": {
|
| 718 |
+
"description": "The matched pipelines.",
|
| 719 |
+
"items": {
|
| 720 |
+
"$ref": "Pipeline"
|
| 721 |
+
},
|
| 722 |
+
"type": "array"
|
| 723 |
+
}
|
| 724 |
+
},
|
| 725 |
+
"type": "object"
|
| 726 |
+
},
|
| 727 |
+
"LocalCopy": {
|
| 728 |
+
"description": "LocalCopy defines how a remote file should be copied to and from the VM.",
|
| 729 |
+
"id": "LocalCopy",
|
| 730 |
+
"properties": {
|
| 731 |
+
"disk": {
|
| 732 |
+
"description": "Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or \"boot\", which represents the Docker instance's boot disk and has a mount point of `/`.",
|
| 733 |
+
"type": "string"
|
| 734 |
+
},
|
| 735 |
+
"path": {
|
| 736 |
+
"description": "Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,",
|
| 737 |
+
"type": "string"
|
| 738 |
+
}
|
| 739 |
+
},
|
| 740 |
+
"type": "object"
|
| 741 |
+
},
|
| 742 |
+
"LoggingOptions": {
|
| 743 |
+
"description": "The logging options for the pipeline run.",
|
| 744 |
+
"id": "LoggingOptions",
|
| 745 |
+
"properties": {
|
| 746 |
+
"gcsPath": {
|
| 747 |
+
"description": "The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`.",
|
| 748 |
+
"type": "string"
|
| 749 |
+
}
|
| 750 |
+
},
|
| 751 |
+
"type": "object"
|
| 752 |
+
},
|
| 753 |
+
"Operation": {
|
| 754 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 755 |
+
"id": "Operation",
|
| 756 |
+
"properties": {
|
| 757 |
+
"done": {
|
| 758 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 759 |
+
"type": "boolean"
|
| 760 |
+
},
|
| 761 |
+
"error": {
|
| 762 |
+
"$ref": "Status",
|
| 763 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 764 |
+
},
|
| 765 |
+
"metadata": {
|
| 766 |
+
"additionalProperties": {
|
| 767 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 768 |
+
"type": "any"
|
| 769 |
+
},
|
| 770 |
+
"description": "An OperationMetadata or Metadata object. This will always be returned with the Operation.",
|
| 771 |
+
"type": "object"
|
| 772 |
+
},
|
| 773 |
+
"name": {
|
| 774 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
|
| 775 |
+
"type": "string"
|
| 776 |
+
},
|
| 777 |
+
"response": {
|
| 778 |
+
"additionalProperties": {
|
| 779 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 780 |
+
"type": "any"
|
| 781 |
+
},
|
| 782 |
+
"description": "An Empty object.",
|
| 783 |
+
"type": "object"
|
| 784 |
+
}
|
| 785 |
+
},
|
| 786 |
+
"type": "object"
|
| 787 |
+
},
|
| 788 |
+
"OperationEvent": {
|
| 789 |
+
"description": "An event that occurred during an Operation.",
|
| 790 |
+
"id": "OperationEvent",
|
| 791 |
+
"properties": {
|
| 792 |
+
"description": {
|
| 793 |
+
"description": "Required description of event.",
|
| 794 |
+
"type": "string"
|
| 795 |
+
},
|
| 796 |
+
"endTime": {
|
| 797 |
+
"description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.",
|
| 798 |
+
"format": "google-datetime",
|
| 799 |
+
"type": "string"
|
| 800 |
+
},
|
| 801 |
+
"startTime": {
|
| 802 |
+
"description": "Optional time of when event started.",
|
| 803 |
+
"format": "google-datetime",
|
| 804 |
+
"type": "string"
|
| 805 |
+
}
|
| 806 |
+
},
|
| 807 |
+
"type": "object"
|
| 808 |
+
},
|
| 809 |
+
"OperationMetadata": {
|
| 810 |
+
"description": "Metadata describing an Operation.",
|
| 811 |
+
"id": "OperationMetadata",
|
| 812 |
+
"properties": {
|
| 813 |
+
"clientId": {
|
| 814 |
+
"description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.",
|
| 815 |
+
"type": "string"
|
| 816 |
+
},
|
| 817 |
+
"createTime": {
|
| 818 |
+
"description": "The time at which the job was submitted to the Genomics service.",
|
| 819 |
+
"format": "google-datetime",
|
| 820 |
+
"type": "string"
|
| 821 |
+
},
|
| 822 |
+
"endTime": {
|
| 823 |
+
"description": "The time at which the job stopped running.",
|
| 824 |
+
"format": "google-datetime",
|
| 825 |
+
"type": "string"
|
| 826 |
+
},
|
| 827 |
+
"events": {
|
| 828 |
+
"description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.",
|
| 829 |
+
"items": {
|
| 830 |
+
"$ref": "OperationEvent"
|
| 831 |
+
},
|
| 832 |
+
"type": "array"
|
| 833 |
+
},
|
| 834 |
+
"labels": {
|
| 835 |
+
"additionalProperties": {
|
| 836 |
+
"type": "string"
|
| 837 |
+
},
|
| 838 |
+
"description": "Optionally provided by the caller when submitting the request that creates the operation.",
|
| 839 |
+
"type": "object"
|
| 840 |
+
},
|
| 841 |
+
"projectId": {
|
| 842 |
+
"description": "The Google Cloud Project in which the job is scoped.",
|
| 843 |
+
"type": "string"
|
| 844 |
+
},
|
| 845 |
+
"request": {
|
| 846 |
+
"additionalProperties": {
|
| 847 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 848 |
+
"type": "any"
|
| 849 |
+
},
|
| 850 |
+
"description": "The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.",
|
| 851 |
+
"type": "object"
|
| 852 |
+
},
|
| 853 |
+
"runtimeMetadata": {
|
| 854 |
+
"additionalProperties": {
|
| 855 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 856 |
+
"type": "any"
|
| 857 |
+
},
|
| 858 |
+
"description": "Runtime metadata on this Operation.",
|
| 859 |
+
"type": "object"
|
| 860 |
+
},
|
| 861 |
+
"startTime": {
|
| 862 |
+
"description": "The time at which the job began to run.",
|
| 863 |
+
"format": "google-datetime",
|
| 864 |
+
"type": "string"
|
| 865 |
+
}
|
| 866 |
+
},
|
| 867 |
+
"type": "object"
|
| 868 |
+
},
|
| 869 |
+
"Pipeline": {
|
| 870 |
+
"description": "The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.",
|
| 871 |
+
"id": "Pipeline",
|
| 872 |
+
"properties": {
|
| 873 |
+
"description": {
|
| 874 |
+
"description": "User-specified description.",
|
| 875 |
+
"type": "string"
|
| 876 |
+
},
|
| 877 |
+
"docker": {
|
| 878 |
+
"$ref": "DockerExecutor",
|
| 879 |
+
"description": "Specifies the docker run information."
|
| 880 |
+
},
|
| 881 |
+
"inputParameters": {
|
| 882 |
+
"description": "Input parameters of the pipeline.",
|
| 883 |
+
"items": {
|
| 884 |
+
"$ref": "PipelineParameter"
|
| 885 |
+
},
|
| 886 |
+
"type": "array"
|
| 887 |
+
},
|
| 888 |
+
"name": {
|
| 889 |
+
"description": "Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.",
|
| 890 |
+
"type": "string"
|
| 891 |
+
},
|
| 892 |
+
"outputParameters": {
|
| 893 |
+
"description": "Output parameters of the pipeline.",
|
| 894 |
+
"items": {
|
| 895 |
+
"$ref": "PipelineParameter"
|
| 896 |
+
},
|
| 897 |
+
"type": "array"
|
| 898 |
+
},
|
| 899 |
+
"pipelineId": {
|
| 900 |
+
"description": "Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.",
|
| 901 |
+
"type": "string"
|
| 902 |
+
},
|
| 903 |
+
"projectId": {
|
| 904 |
+
"description": "Required. The project in which to create the pipeline. The caller must have WRITE access.",
|
| 905 |
+
"type": "string"
|
| 906 |
+
},
|
| 907 |
+
"resources": {
|
| 908 |
+
"$ref": "PipelineResources",
|
| 909 |
+
"description": "Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb"
|
| 910 |
+
}
|
| 911 |
+
},
|
| 912 |
+
"type": "object"
|
| 913 |
+
},
|
| 914 |
+
"PipelineParameter": {
|
| 915 |
+
"description": "Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: \"pd1\", mountPoint: \"/mnt/disk/\"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.",
|
| 916 |
+
"id": "PipelineParameter",
|
| 917 |
+
"properties": {
|
| 918 |
+
"defaultValue": {
|
| 919 |
+
"description": "The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.",
|
| 920 |
+
"type": "string"
|
| 921 |
+
},
|
| 922 |
+
"description": {
|
| 923 |
+
"description": "Human-readable description.",
|
| 924 |
+
"type": "string"
|
| 925 |
+
},
|
| 926 |
+
"localCopy": {
|
| 927 |
+
"$ref": "LocalCopy",
|
| 928 |
+
"description": "If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be."
|
| 929 |
+
},
|
| 930 |
+
"name": {
|
| 931 |
+
"description": "Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.",
|
| 932 |
+
"type": "string"
|
| 933 |
+
}
|
| 934 |
+
},
|
| 935 |
+
"type": "object"
|
| 936 |
+
},
|
| 937 |
+
"PipelineResources": {
|
| 938 |
+
"description": "The system resources for the pipeline run.",
|
| 939 |
+
"id": "PipelineResources",
|
| 940 |
+
"properties": {
|
| 941 |
+
"acceleratorCount": {
|
| 942 |
+
"description": "Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA\u00ae Tesla\u00ae drivers and NVIDIA\u00ae CUDA toolkit.",
|
| 943 |
+
"format": "int64",
|
| 944 |
+
"type": "string"
|
| 945 |
+
},
|
| 946 |
+
"acceleratorType": {
|
| 947 |
+
"description": "Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA\u00ae Tesla\u00ae drivers and NVIDIA\u00ae CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.",
|
| 948 |
+
"type": "string"
|
| 949 |
+
},
|
| 950 |
+
"bootDiskSizeGb": {
|
| 951 |
+
"description": "The size of the boot disk. Defaults to 10 (GB).",
|
| 952 |
+
"format": "int32",
|
| 953 |
+
"type": "integer"
|
| 954 |
+
},
|
| 955 |
+
"disks": {
|
| 956 |
+
"description": "Disks to attach.",
|
| 957 |
+
"items": {
|
| 958 |
+
"$ref": "Disk"
|
| 959 |
+
},
|
| 960 |
+
"type": "array"
|
| 961 |
+
},
|
| 962 |
+
"minimumCpuCores": {
|
| 963 |
+
"description": "The minimum number of cores to use. Defaults to 1.",
|
| 964 |
+
"format": "int32",
|
| 965 |
+
"type": "integer"
|
| 966 |
+
},
|
| 967 |
+
"minimumRamGb": {
|
| 968 |
+
"description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
|
| 969 |
+
"format": "double",
|
| 970 |
+
"type": "number"
|
| 971 |
+
},
|
| 972 |
+
"noAddress": {
|
| 973 |
+
"description": "Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).",
|
| 974 |
+
"type": "boolean"
|
| 975 |
+
},
|
| 976 |
+
"preemptible": {
|
| 977 |
+
"description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.",
|
| 978 |
+
"type": "boolean"
|
| 979 |
+
},
|
| 980 |
+
"zones": {
|
| 981 |
+
"description": "List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.",
|
| 982 |
+
"items": {
|
| 983 |
+
"type": "string"
|
| 984 |
+
},
|
| 985 |
+
"type": "array"
|
| 986 |
+
}
|
| 987 |
+
},
|
| 988 |
+
"type": "object"
|
| 989 |
+
},
|
| 990 |
+
"PullStartedEvent": {
|
| 991 |
+
"description": "An event generated when the worker starts pulling an image.",
|
| 992 |
+
"id": "PullStartedEvent",
|
| 993 |
+
"properties": {
|
| 994 |
+
"imageUri": {
|
| 995 |
+
"description": "The URI of the image that was pulled.",
|
| 996 |
+
"type": "string"
|
| 997 |
+
}
|
| 998 |
+
},
|
| 999 |
+
"type": "object"
|
| 1000 |
+
},
|
| 1001 |
+
"PullStoppedEvent": {
|
| 1002 |
+
"description": "An event generated when the worker stops pulling an image.",
|
| 1003 |
+
"id": "PullStoppedEvent",
|
| 1004 |
+
"properties": {
|
| 1005 |
+
"imageUri": {
|
| 1006 |
+
"description": "The URI of the image that was pulled.",
|
| 1007 |
+
"type": "string"
|
| 1008 |
+
}
|
| 1009 |
+
},
|
| 1010 |
+
"type": "object"
|
| 1011 |
+
},
|
| 1012 |
+
"RepeatedString": {
|
| 1013 |
+
"id": "RepeatedString",
|
| 1014 |
+
"properties": {
|
| 1015 |
+
"values": {
|
| 1016 |
+
"items": {
|
| 1017 |
+
"type": "string"
|
| 1018 |
+
},
|
| 1019 |
+
"type": "array"
|
| 1020 |
+
}
|
| 1021 |
+
},
|
| 1022 |
+
"type": "object"
|
| 1023 |
+
},
|
| 1024 |
+
"RunPipelineArgs": {
|
| 1025 |
+
"description": "The pipeline run arguments.",
|
| 1026 |
+
"id": "RunPipelineArgs",
|
| 1027 |
+
"properties": {
|
| 1028 |
+
"clientId": {
|
| 1029 |
+
"description": "This field is deprecated. Use `labels` instead. Client-specified pipeline operation identifier.",
|
| 1030 |
+
"type": "string"
|
| 1031 |
+
},
|
| 1032 |
+
"inputs": {
|
| 1033 |
+
"additionalProperties": {
|
| 1034 |
+
"type": "string"
|
| 1035 |
+
},
|
| 1036 |
+
"description": "Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.",
|
| 1037 |
+
"type": "object"
|
| 1038 |
+
},
|
| 1039 |
+
"keepVmAliveOnFailureDuration": {
|
| 1040 |
+
"description": "How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
|
| 1041 |
+
"format": "google-duration",
|
| 1042 |
+
"type": "string"
|
| 1043 |
+
},
|
| 1044 |
+
"labels": {
|
| 1045 |
+
"additionalProperties": {
|
| 1046 |
+
"type": "string"
|
| 1047 |
+
},
|
| 1048 |
+
"description": "Labels to apply to this pipeline run. Labels will also be applied to compute resources (VM, disks) created by this pipeline run. When listing operations, operations can filtered by labels. Label keys may not be empty; label values may be empty. Non-empty labels must be 1-63 characters long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
|
| 1049 |
+
"type": "object"
|
| 1050 |
+
},
|
| 1051 |
+
"logging": {
|
| 1052 |
+
"$ref": "LoggingOptions",
|
| 1053 |
+
"description": "Required. Logging options. Used by the service to communicate results to the user."
|
| 1054 |
+
},
|
| 1055 |
+
"outputs": {
|
| 1056 |
+
"additionalProperties": {
|
| 1057 |
+
"type": "string"
|
| 1058 |
+
},
|
| 1059 |
+
"description": "Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.",
|
| 1060 |
+
"type": "object"
|
| 1061 |
+
},
|
| 1062 |
+
"projectId": {
|
| 1063 |
+
"description": "Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used.",
|
| 1064 |
+
"type": "string"
|
| 1065 |
+
},
|
| 1066 |
+
"resources": {
|
| 1067 |
+
"$ref": "PipelineResources",
|
| 1068 |
+
"description": "Specifies resource requirements/overrides for the pipeline run."
|
| 1069 |
+
},
|
| 1070 |
+
"serviceAccount": {
|
| 1071 |
+
"$ref": "ServiceAccount",
|
| 1072 |
+
"description": "The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used."
|
| 1073 |
+
}
|
| 1074 |
+
},
|
| 1075 |
+
"type": "object"
|
| 1076 |
+
},
|
| 1077 |
+
"RunPipelineRequest": {
|
| 1078 |
+
"description": "The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.",
|
| 1079 |
+
"id": "RunPipelineRequest",
|
| 1080 |
+
"properties": {
|
| 1081 |
+
"ephemeralPipeline": {
|
| 1082 |
+
"$ref": "Pipeline",
|
| 1083 |
+
"description": "A new pipeline object to run once and then delete."
|
| 1084 |
+
},
|
| 1085 |
+
"pipelineArgs": {
|
| 1086 |
+
"$ref": "RunPipelineArgs",
|
| 1087 |
+
"description": "The arguments to use when running this pipeline."
|
| 1088 |
+
},
|
| 1089 |
+
"pipelineId": {
|
| 1090 |
+
"description": "The already created pipeline to run.",
|
| 1091 |
+
"type": "string"
|
| 1092 |
+
}
|
| 1093 |
+
},
|
| 1094 |
+
"type": "object"
|
| 1095 |
+
},
|
| 1096 |
+
"RunPipelineResponse": {
|
| 1097 |
+
"description": "The response to the RunPipeline method, returned in the operation's result field on success.",
|
| 1098 |
+
"id": "RunPipelineResponse",
|
| 1099 |
+
"properties": {},
|
| 1100 |
+
"type": "object"
|
| 1101 |
+
},
|
| 1102 |
+
"RuntimeMetadata": {
|
| 1103 |
+
"description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.",
|
| 1104 |
+
"id": "RuntimeMetadata",
|
| 1105 |
+
"properties": {
|
| 1106 |
+
"computeEngine": {
|
| 1107 |
+
"$ref": "ComputeEngine",
|
| 1108 |
+
"description": "Execution information specific to Google Compute Engine."
|
| 1109 |
+
}
|
| 1110 |
+
},
|
| 1111 |
+
"type": "object"
|
| 1112 |
+
},
|
| 1113 |
+
"ServiceAccount": {
|
| 1114 |
+
"description": "A Google Cloud Service Account.",
|
| 1115 |
+
"id": "ServiceAccount",
|
| 1116 |
+
"properties": {
|
| 1117 |
+
"email": {
|
| 1118 |
+
"description": "Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project.",
|
| 1119 |
+
"type": "string"
|
| 1120 |
+
},
|
| 1121 |
+
"scopes": {
|
| 1122 |
+
"description": "List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write",
|
| 1123 |
+
"items": {
|
| 1124 |
+
"type": "string"
|
| 1125 |
+
},
|
| 1126 |
+
"type": "array"
|
| 1127 |
+
}
|
| 1128 |
+
},
|
| 1129 |
+
"type": "object"
|
| 1130 |
+
},
|
| 1131 |
+
"SetOperationStatusRequest": {
|
| 1132 |
+
"description": "Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.",
|
| 1133 |
+
"id": "SetOperationStatusRequest",
|
| 1134 |
+
"properties": {
|
| 1135 |
+
"errorCode": {
|
| 1136 |
+
"enum": [
|
| 1137 |
+
"OK",
|
| 1138 |
+
"CANCELLED",
|
| 1139 |
+
"UNKNOWN",
|
| 1140 |
+
"INVALID_ARGUMENT",
|
| 1141 |
+
"DEADLINE_EXCEEDED",
|
| 1142 |
+
"NOT_FOUND",
|
| 1143 |
+
"ALREADY_EXISTS",
|
| 1144 |
+
"PERMISSION_DENIED",
|
| 1145 |
+
"UNAUTHENTICATED",
|
| 1146 |
+
"RESOURCE_EXHAUSTED",
|
| 1147 |
+
"FAILED_PRECONDITION",
|
| 1148 |
+
"ABORTED",
|
| 1149 |
+
"OUT_OF_RANGE",
|
| 1150 |
+
"UNIMPLEMENTED",
|
| 1151 |
+
"INTERNAL",
|
| 1152 |
+
"UNAVAILABLE",
|
| 1153 |
+
"DATA_LOSS"
|
| 1154 |
+
],
|
| 1155 |
+
"enumDescriptions": [
|
| 1156 |
+
"Not an error; returned on success HTTP Mapping: 200 OK",
|
| 1157 |
+
"The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
|
| 1158 |
+
"Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
|
| 1159 |
+
"The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
|
| 1160 |
+
"The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
|
| 1161 |
+
"Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
|
| 1162 |
+
"The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
|
| 1163 |
+
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
|
| 1164 |
+
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
|
| 1165 |
+
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
|
| 1166 |
+
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
|
| 1167 |
+
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
|
| 1168 |
+
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
|
| 1169 |
+
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
|
| 1170 |
+
"Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
|
| 1171 |
+
"The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
|
| 1172 |
+
"Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
|
| 1173 |
+
],
|
| 1174 |
+
"type": "string"
|
| 1175 |
+
},
|
| 1176 |
+
"errorMessage": {
|
| 1177 |
+
"type": "string"
|
| 1178 |
+
},
|
| 1179 |
+
"operationId": {
|
| 1180 |
+
"type": "string"
|
| 1181 |
+
},
|
| 1182 |
+
"timestampEvents": {
|
| 1183 |
+
"items": {
|
| 1184 |
+
"$ref": "TimestampEvent"
|
| 1185 |
+
},
|
| 1186 |
+
"type": "array"
|
| 1187 |
+
},
|
| 1188 |
+
"validationToken": {
|
| 1189 |
+
"format": "uint64",
|
| 1190 |
+
"type": "string"
|
| 1191 |
+
}
|
| 1192 |
+
},
|
| 1193 |
+
"type": "object"
|
| 1194 |
+
},
|
| 1195 |
+
"Status": {
|
| 1196 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 1197 |
+
"id": "Status",
|
| 1198 |
+
"properties": {
|
| 1199 |
+
"code": {
|
| 1200 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 1201 |
+
"format": "int32",
|
| 1202 |
+
"type": "integer"
|
| 1203 |
+
},
|
| 1204 |
+
"details": {
|
| 1205 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 1206 |
+
"items": {
|
| 1207 |
+
"additionalProperties": {
|
| 1208 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1209 |
+
"type": "any"
|
| 1210 |
+
},
|
| 1211 |
+
"type": "object"
|
| 1212 |
+
},
|
| 1213 |
+
"type": "array"
|
| 1214 |
+
},
|
| 1215 |
+
"message": {
|
| 1216 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 1217 |
+
"type": "string"
|
| 1218 |
+
}
|
| 1219 |
+
},
|
| 1220 |
+
"type": "object"
|
| 1221 |
+
},
|
| 1222 |
+
"TimestampEvent": {
|
| 1223 |
+
"description": "Stores the list of events and times they occured for major events in job execution.",
|
| 1224 |
+
"id": "TimestampEvent",
|
| 1225 |
+
"properties": {
|
| 1226 |
+
"description": {
|
| 1227 |
+
"description": "String indicating the type of event",
|
| 1228 |
+
"type": "string"
|
| 1229 |
+
},
|
| 1230 |
+
"timestamp": {
|
| 1231 |
+
"description": "The time this event occured.",
|
| 1232 |
+
"format": "google-datetime",
|
| 1233 |
+
"type": "string"
|
| 1234 |
+
}
|
| 1235 |
+
},
|
| 1236 |
+
"type": "object"
|
| 1237 |
+
},
|
| 1238 |
+
"UnexpectedExitStatusEvent": {
|
| 1239 |
+
"description": "An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.",
|
| 1240 |
+
"id": "UnexpectedExitStatusEvent",
|
| 1241 |
+
"properties": {
|
| 1242 |
+
"actionId": {
|
| 1243 |
+
"description": "The numeric ID of the action that started the container.",
|
| 1244 |
+
"format": "int32",
|
| 1245 |
+
"type": "integer"
|
| 1246 |
+
},
|
| 1247 |
+
"exitStatus": {
|
| 1248 |
+
"description": "The exit status of the container.",
|
| 1249 |
+
"format": "int32",
|
| 1250 |
+
"type": "integer"
|
| 1251 |
+
}
|
| 1252 |
+
},
|
| 1253 |
+
"type": "object"
|
| 1254 |
+
},
|
| 1255 |
+
"WorkerAssignedEvent": {
|
| 1256 |
+
"description": "An event generated after a worker VM has been assigned to run the pipeline.",
|
| 1257 |
+
"id": "WorkerAssignedEvent",
|
| 1258 |
+
"properties": {
|
| 1259 |
+
"instance": {
|
| 1260 |
+
"description": "The worker's instance name.",
|
| 1261 |
+
"type": "string"
|
| 1262 |
+
},
|
| 1263 |
+
"machineType": {
|
| 1264 |
+
"description": "The machine type that was assigned for the worker.",
|
| 1265 |
+
"type": "string"
|
| 1266 |
+
},
|
| 1267 |
+
"zone": {
|
| 1268 |
+
"description": "The zone the worker is running in.",
|
| 1269 |
+
"type": "string"
|
| 1270 |
+
}
|
| 1271 |
+
},
|
| 1272 |
+
"type": "object"
|
| 1273 |
+
},
|
| 1274 |
+
"WorkerReleasedEvent": {
|
| 1275 |
+
"description": "An event generated when the worker VM that was assigned to the pipeline has been released (deleted).",
|
| 1276 |
+
"id": "WorkerReleasedEvent",
|
| 1277 |
+
"properties": {
|
| 1278 |
+
"instance": {
|
| 1279 |
+
"description": "The worker's instance name.",
|
| 1280 |
+
"type": "string"
|
| 1281 |
+
},
|
| 1282 |
+
"zone": {
|
| 1283 |
+
"description": "The zone the worker was running in.",
|
| 1284 |
+
"type": "string"
|
| 1285 |
+
}
|
| 1286 |
+
},
|
| 1287 |
+
"type": "object"
|
| 1288 |
+
}
|
| 1289 |
+
},
|
| 1290 |
+
"servicePath": "",
|
| 1291 |
+
"title": "Genomics API",
|
| 1292 |
+
"version": "v1alpha2"
|
| 1293 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/gkehub.v2beta.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/groupssettings.v1.json
ADDED
|
@@ -0,0 +1,419 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/apps.groups.settings": {
|
| 6 |
+
"description": "View and manage the settings of a G Suite group"
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "/groups/v1/groups/",
|
| 12 |
+
"baseUrl": "https://www.googleapis.com/groups/v1/groups/",
|
| 13 |
+
"batchPath": "batch/groupssettings/v1",
|
| 14 |
+
"description": "Manages permission levels and related settings of a group.",
|
| 15 |
+
"discoveryVersion": "v1",
|
| 16 |
+
"documentationLink": "https://developers.google.com/google-apps/groups-settings/get_started",
|
| 17 |
+
"icons": {
|
| 18 |
+
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
|
| 19 |
+
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
|
| 20 |
+
},
|
| 21 |
+
"id": "groupssettings:v1",
|
| 22 |
+
"kind": "discovery#restDescription",
|
| 23 |
+
"name": "groupssettings",
|
| 24 |
+
"ownerDomain": "google.com",
|
| 25 |
+
"ownerName": "Google",
|
| 26 |
+
"parameters": {
|
| 27 |
+
"alt": {
|
| 28 |
+
"default": "atom",
|
| 29 |
+
"description": "Data format for the response.",
|
| 30 |
+
"enum": [
|
| 31 |
+
"atom",
|
| 32 |
+
"json"
|
| 33 |
+
],
|
| 34 |
+
"enumDescriptions": [
|
| 35 |
+
"Responses with Content-Type of application/atom+xml",
|
| 36 |
+
"Responses with Content-Type of application/json"
|
| 37 |
+
],
|
| 38 |
+
"location": "query",
|
| 39 |
+
"type": "string"
|
| 40 |
+
},
|
| 41 |
+
"fields": {
|
| 42 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"key": {
|
| 47 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"oauth_token": {
|
| 52 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 53 |
+
"location": "query",
|
| 54 |
+
"type": "string"
|
| 55 |
+
},
|
| 56 |
+
"prettyPrint": {
|
| 57 |
+
"default": "true",
|
| 58 |
+
"description": "Returns response with indentations and line breaks.",
|
| 59 |
+
"location": "query",
|
| 60 |
+
"type": "boolean"
|
| 61 |
+
},
|
| 62 |
+
"quotaUser": {
|
| 63 |
+
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"userIp": {
|
| 68 |
+
"description": "Deprecated. Please use quotaUser instead.",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
}
|
| 72 |
+
},
|
| 73 |
+
"protocol": "rest",
|
| 74 |
+
"resources": {
|
| 75 |
+
"groups": {
|
| 76 |
+
"methods": {
|
| 77 |
+
"get": {
|
| 78 |
+
"description": "Gets one resource by id.",
|
| 79 |
+
"httpMethod": "GET",
|
| 80 |
+
"id": "groupsSettings.groups.get",
|
| 81 |
+
"parameterOrder": [
|
| 82 |
+
"groupUniqueId"
|
| 83 |
+
],
|
| 84 |
+
"parameters": {
|
| 85 |
+
"groupUniqueId": {
|
| 86 |
+
"description": "The group's email address.",
|
| 87 |
+
"location": "path",
|
| 88 |
+
"required": true,
|
| 89 |
+
"type": "string"
|
| 90 |
+
}
|
| 91 |
+
},
|
| 92 |
+
"path": "{groupUniqueId}",
|
| 93 |
+
"response": {
|
| 94 |
+
"$ref": "Groups"
|
| 95 |
+
},
|
| 96 |
+
"scopes": [
|
| 97 |
+
"https://www.googleapis.com/auth/apps.groups.settings"
|
| 98 |
+
]
|
| 99 |
+
},
|
| 100 |
+
"patch": {
|
| 101 |
+
"description": "Updates an existing resource. This method supports patch semantics.",
|
| 102 |
+
"httpMethod": "PATCH",
|
| 103 |
+
"id": "groupsSettings.groups.patch",
|
| 104 |
+
"parameterOrder": [
|
| 105 |
+
"groupUniqueId"
|
| 106 |
+
],
|
| 107 |
+
"parameters": {
|
| 108 |
+
"groupUniqueId": {
|
| 109 |
+
"description": "The group's email address.",
|
| 110 |
+
"location": "path",
|
| 111 |
+
"required": true,
|
| 112 |
+
"type": "string"
|
| 113 |
+
}
|
| 114 |
+
},
|
| 115 |
+
"path": "{groupUniqueId}",
|
| 116 |
+
"request": {
|
| 117 |
+
"$ref": "Groups"
|
| 118 |
+
},
|
| 119 |
+
"response": {
|
| 120 |
+
"$ref": "Groups"
|
| 121 |
+
},
|
| 122 |
+
"scopes": [
|
| 123 |
+
"https://www.googleapis.com/auth/apps.groups.settings"
|
| 124 |
+
]
|
| 125 |
+
},
|
| 126 |
+
"update": {
|
| 127 |
+
"description": "Updates an existing resource.",
|
| 128 |
+
"httpMethod": "PUT",
|
| 129 |
+
"id": "groupsSettings.groups.update",
|
| 130 |
+
"parameterOrder": [
|
| 131 |
+
"groupUniqueId"
|
| 132 |
+
],
|
| 133 |
+
"parameters": {
|
| 134 |
+
"groupUniqueId": {
|
| 135 |
+
"description": "The group's email address.",
|
| 136 |
+
"location": "path",
|
| 137 |
+
"required": true,
|
| 138 |
+
"type": "string"
|
| 139 |
+
}
|
| 140 |
+
},
|
| 141 |
+
"path": "{groupUniqueId}",
|
| 142 |
+
"request": {
|
| 143 |
+
"$ref": "Groups"
|
| 144 |
+
},
|
| 145 |
+
"response": {
|
| 146 |
+
"$ref": "Groups"
|
| 147 |
+
},
|
| 148 |
+
"scopes": [
|
| 149 |
+
"https://www.googleapis.com/auth/apps.groups.settings"
|
| 150 |
+
]
|
| 151 |
+
}
|
| 152 |
+
}
|
| 153 |
+
}
|
| 154 |
+
},
|
| 155 |
+
"revision": "20220614",
|
| 156 |
+
"rootUrl": "https://www.googleapis.com/",
|
| 157 |
+
"schemas": {
|
| 158 |
+
"Groups": {
|
| 159 |
+
"description": "JSON template for Group resource",
|
| 160 |
+
"id": "Groups",
|
| 161 |
+
"properties": {
|
| 162 |
+
"allowExternalMembers": {
|
| 163 |
+
"description": "Identifies whether members external to your organization can join the group. Possible values are: \n- true: G Suite users external to your organization can become members of this group. \n- false: Users not belonging to the organization are not allowed to become members of this group.",
|
| 164 |
+
"type": "string"
|
| 165 |
+
},
|
| 166 |
+
"allowGoogleCommunication": {
|
| 167 |
+
"description": "Deprecated. Allows Google to contact administrator of the group. \n- true: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group. \n- false: Google can not contact managers of this group.",
|
| 168 |
+
"type": "string"
|
| 169 |
+
},
|
| 170 |
+
"allowWebPosting": {
|
| 171 |
+
"description": "Allows posting from web. Possible values are: \n- true: Allows any member to post to the group forum. \n- false: Members only use Gmail to communicate with the group.",
|
| 172 |
+
"type": "string"
|
| 173 |
+
},
|
| 174 |
+
"archiveOnly": {
|
| 175 |
+
"description": "Allows the group to be archived only. Possible values are: \n- true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable. \n- If true, the whoCanPostMessage property is set to NONE_CAN_POST. \n- If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST. \n- false: The group is active and can receive messages. \n- When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.",
|
| 176 |
+
"type": "string"
|
| 177 |
+
},
|
| 178 |
+
"customFooterText": {
|
| 179 |
+
"description": "Set the content of custom footer text. The maximum number of characters is 1,000.",
|
| 180 |
+
"type": "string"
|
| 181 |
+
},
|
| 182 |
+
"customReplyTo": {
|
| 183 |
+
"description": "An email address used when replying to a message if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined by an account administrator. \n- When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds a custom email address used when replying to a message. \n- If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a text value or an error is returned.",
|
| 184 |
+
"type": "string"
|
| 185 |
+
},
|
| 186 |
+
"customRolesEnabledForSettingsToBeMerged": {
|
| 187 |
+
"description": "Specifies whether the group has a custom role that's included in one of the settings being merged. This field is read-only and update/patch requests to it are ignored. Possible values are: \n- true \n- false",
|
| 188 |
+
"type": "string"
|
| 189 |
+
},
|
| 190 |
+
"defaultMessageDenyNotificationText": {
|
| 191 |
+
"description": "When a message is rejected, this is text for the rejection notification sent to the message's author. By default, this property is empty and has no value in the API's response body. The maximum notification text size is 10,000 characters. Note: Requires sendMessageDenyNotification property to be true.",
|
| 192 |
+
"type": "string"
|
| 193 |
+
},
|
| 194 |
+
"default_sender": {
|
| 195 |
+
"description": "Default sender for members who can post messages as the group. Possible values are: - `DEFAULT_SELF`: By default messages will be sent from the user - `GROUP`: By default messages will be sent from the group",
|
| 196 |
+
"type": "string"
|
| 197 |
+
},
|
| 198 |
+
"description": {
|
| 199 |
+
"description": "Description of the group. This property value may be an empty string if no group description has been entered. If entered, the maximum group description is no more than 300 characters.",
|
| 200 |
+
"type": "string"
|
| 201 |
+
},
|
| 202 |
+
"email": {
|
| 203 |
+
"description": "The group's email address. This property can be updated using the Directory API. Note: Only a group owner can change a group's email address. A group manager can't do this.\nWhen you change your group's address using the Directory API or the control panel, you are changing the address your subscribers use to send email and the web address people use to access your group. People can't reach your group by visiting the old address.",
|
| 204 |
+
"type": "string"
|
| 205 |
+
},
|
| 206 |
+
"enableCollaborativeInbox": {
|
| 207 |
+
"description": "Specifies whether a collaborative inbox will remain turned on for the group. Possible values are: \n- true \n- false",
|
| 208 |
+
"type": "string"
|
| 209 |
+
},
|
| 210 |
+
"favoriteRepliesOnTop": {
|
| 211 |
+
"description": "Indicates if favorite replies should be displayed above other replies. \n- true: Favorite replies will be displayed above other replies. \n- false: Favorite replies will not be displayed above other replies.",
|
| 212 |
+
"type": "string"
|
| 213 |
+
},
|
| 214 |
+
"includeCustomFooter": {
|
| 215 |
+
"description": "Whether to include custom footer. Possible values are: \n- true \n- false",
|
| 216 |
+
"type": "string"
|
| 217 |
+
},
|
| 218 |
+
"includeInGlobalAddressList": {
|
| 219 |
+
"description": "Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are: \n- true: Group is included in the Global Address List. \n- false: Group is not included in the Global Address List.",
|
| 220 |
+
"type": "string"
|
| 221 |
+
},
|
| 222 |
+
"isArchived": {
|
| 223 |
+
"description": "Allows the Group contents to be archived. Possible values are: \n- true: Archive messages sent to the group. \n- false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.",
|
| 224 |
+
"type": "string"
|
| 225 |
+
},
|
| 226 |
+
"kind": {
|
| 227 |
+
"default": "groupsSettings#groups",
|
| 228 |
+
"description": "The type of the resource. It is always groupsSettings#groups.",
|
| 229 |
+
"type": "string"
|
| 230 |
+
},
|
| 231 |
+
"maxMessageBytes": {
|
| 232 |
+
"description": "Deprecated. The maximum size of a message is 25Mb.",
|
| 233 |
+
"format": "int32",
|
| 234 |
+
"type": "integer"
|
| 235 |
+
},
|
| 236 |
+
"membersCanPostAsTheGroup": {
|
| 237 |
+
"description": "Enables members to post messages as the group. Possible values are: \n- true: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself. Note: When true, any message moderation settings on individual users or new members do not apply to posts made on behalf of the group. \n- false: Members can not post in behalf of the group's email address.",
|
| 238 |
+
"type": "string"
|
| 239 |
+
},
|
| 240 |
+
"messageDisplayFont": {
|
| 241 |
+
"description": "Deprecated. The default message display font always has a value of \"DEFAULT_FONT\".",
|
| 242 |
+
"type": "string"
|
| 243 |
+
},
|
| 244 |
+
"messageModerationLevel": {
|
| 245 |
+
"description": "Moderation level of incoming messages. Possible values are: \n- MODERATE_ALL_MESSAGES: All messages are sent to the group owner's email address for approval. If approved, the message is sent to the group. \n- MODERATE_NON_MEMBERS: All messages from non group members are sent to the group owner's email address for approval. If approved, the message is sent to the group. \n- MODERATE_NEW_MEMBERS: All messages from new members are sent to the group owner's email address for approval. If approved, the message is sent to the group. \n- MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group. Note: When the whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.\nWhen memberCanPostAsTheGroup is true, any message moderation settings on individual users or new members will not apply to posts made on behalf of the group.",
|
| 246 |
+
"type": "string"
|
| 247 |
+
},
|
| 248 |
+
"name": {
|
| 249 |
+
"description": "Name of the group, which has a maximum size of 75 characters.",
|
| 250 |
+
"type": "string"
|
| 251 |
+
},
|
| 252 |
+
"primaryLanguage": {
|
| 253 |
+
"description": "The primary language for group. For a group's primary language use the language tags from the G Suite languages found at G Suite Email Settings API Email Language Tags.",
|
| 254 |
+
"type": "string"
|
| 255 |
+
},
|
| 256 |
+
"replyTo": {
|
| 257 |
+
"description": "Specifies who receives the default reply. Possible values are: \n- REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.\nWhen the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds the custom email address used when replying to a message. If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a value. Otherwise an error is returned.\n \n- REPLY_TO_SENDER: The reply sent to author of message. \n- REPLY_TO_LIST: This reply message is sent to the group. \n- REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers. \n- REPLY_TO_IGNORE: Group users individually decide where the message reply is sent. \n- REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.",
|
| 258 |
+
"type": "string"
|
| 259 |
+
},
|
| 260 |
+
"sendMessageDenyNotification": {
|
| 261 |
+
"description": "Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are: \n- true: When a message is rejected, send the deny message notification to the message author.\nThe defaultMessageDenyNotificationText property is dependent on the sendMessageDenyNotification property being true.\n \n- false: When a message is rejected, no notification is sent.",
|
| 262 |
+
"type": "string"
|
| 263 |
+
},
|
| 264 |
+
"showInGroupDirectory": {
|
| 265 |
+
"description": "Deprecated. This is merged into the new whoCanDiscoverGroup setting. Allows the group to be visible in the Groups Directory. Possible values are: \n- true: All groups in the account are listed in the Groups directory. \n- false: All groups in the account are not listed in the directory.",
|
| 266 |
+
"type": "string"
|
| 267 |
+
},
|
| 268 |
+
"spamModerationLevel": {
|
| 269 |
+
"description": "Specifies moderation levels for messages detected as spam. Possible values are: \n- ALLOW: Post the message to the group. \n- MODERATE: Send the message to the moderation queue. This is the default. \n- SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators. \n- REJECT: Immediately reject the message.",
|
| 270 |
+
"type": "string"
|
| 271 |
+
},
|
| 272 |
+
"whoCanAdd": {
|
| 273 |
+
"description": "Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to add members. Possible values are: \n- ALL_MEMBERS_CAN_ADD: Managers and members can directly add new members. \n- ALL_MANAGERS_CAN_ADD: Only managers can directly add new members. this includes the group's owner. \n- ALL_OWNERS_CAN_ADD: Only owners can directly add new members. \n- NONE_CAN_ADD: No one can directly add new members.",
|
| 274 |
+
"type": "string"
|
| 275 |
+
},
|
| 276 |
+
"whoCanAddReferences": {
|
| 277 |
+
"description": "Deprecated. This functionality is no longer supported in the Google Groups UI. The value is always \"NONE\".",
|
| 278 |
+
"type": "string"
|
| 279 |
+
},
|
| 280 |
+
"whoCanApproveMembers": {
|
| 281 |
+
"description": "Specifies who can approve members who ask to join groups. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are: \n- ALL_MEMBERS_CAN_APPROVE \n- ALL_MANAGERS_CAN_APPROVE \n- ALL_OWNERS_CAN_APPROVE \n- NONE_CAN_APPROVE",
|
| 282 |
+
"type": "string"
|
| 283 |
+
},
|
| 284 |
+
"whoCanApproveMessages": {
|
| 285 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can approve pending messages in the moderation queue. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 286 |
+
"type": "string"
|
| 287 |
+
},
|
| 288 |
+
"whoCanAssignTopics": {
|
| 289 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to assign topics in a forum to another user. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 290 |
+
"type": "string"
|
| 291 |
+
},
|
| 292 |
+
"whoCanAssistContent": {
|
| 293 |
+
"description": "Specifies who can moderate metadata. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 294 |
+
"type": "string"
|
| 295 |
+
},
|
| 296 |
+
"whoCanBanUsers": {
|
| 297 |
+
"description": "Specifies who can deny membership to users. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 298 |
+
"type": "string"
|
| 299 |
+
},
|
| 300 |
+
"whoCanContactOwner": {
|
| 301 |
+
"description": "Permission to contact owner of the group via web UI. Possible values are: \n- ALL_IN_DOMAIN_CAN_CONTACT \n- ALL_MANAGERS_CAN_CONTACT \n- ALL_MEMBERS_CAN_CONTACT \n- ANYONE_CAN_CONTACT \n- ALL_OWNERS_CAN_CONTACT",
|
| 302 |
+
"type": "string"
|
| 303 |
+
},
|
| 304 |
+
"whoCanDeleteAnyPost": {
|
| 305 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 306 |
+
"type": "string"
|
| 307 |
+
},
|
| 308 |
+
"whoCanDeleteTopics": {
|
| 309 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete topics. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 310 |
+
"type": "string"
|
| 311 |
+
},
|
| 312 |
+
"whoCanDiscoverGroup": {
|
| 313 |
+
"description": "Specifies the set of users for whom this group is discoverable. Possible values are: \n- ANYONE_CAN_DISCOVER \n- ALL_IN_DOMAIN_CAN_DISCOVER \n- ALL_MEMBERS_CAN_DISCOVER",
|
| 314 |
+
"type": "string"
|
| 315 |
+
},
|
| 316 |
+
"whoCanEnterFreeFormTags": {
|
| 317 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to enter free form tags for topics in a forum. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 318 |
+
"type": "string"
|
| 319 |
+
},
|
| 320 |
+
"whoCanHideAbuse": {
|
| 321 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can hide posts by reporting them as abuse. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 322 |
+
"type": "string"
|
| 323 |
+
},
|
| 324 |
+
"whoCanInvite": {
|
| 325 |
+
"description": "Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to invite new members. Possible values are: \n- ALL_MEMBERS_CAN_INVITE: Managers and members can invite a new member candidate. \n- ALL_MANAGERS_CAN_INVITE: Only managers can invite a new member. This includes the group's owner. \n- ALL_OWNERS_CAN_INVITE: Only owners can invite a new member. \n- NONE_CAN_INVITE: No one can invite a new member candidate.",
|
| 326 |
+
"type": "string"
|
| 327 |
+
},
|
| 328 |
+
"whoCanJoin": {
|
| 329 |
+
"description": "Permission to join group. Possible values are: \n- ANYONE_CAN_JOIN: Any Internet user who is outside your domain can access your Google Groups service and view the list of groups in your Groups directory. Warning: Group owners can add external addresses, outside of the domain to their groups. They can also allow people outside your domain to join their groups. If you later disable this option, any external addresses already added to users' groups remain in those groups. \n- ALL_IN_DOMAIN_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains. \n- INVITED_CAN_JOIN: Candidates for membership can be invited to join. \n- CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.",
|
| 330 |
+
"type": "string"
|
| 331 |
+
},
|
| 332 |
+
"whoCanLeaveGroup": {
|
| 333 |
+
"description": "Permission to leave the group. Possible values are: \n- ALL_MANAGERS_CAN_LEAVE \n- ALL_MEMBERS_CAN_LEAVE \n- NONE_CAN_LEAVE",
|
| 334 |
+
"type": "string"
|
| 335 |
+
},
|
| 336 |
+
"whoCanLockTopics": {
|
| 337 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can prevent users from posting replies to topics. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 338 |
+
"type": "string"
|
| 339 |
+
},
|
| 340 |
+
"whoCanMakeTopicsSticky": {
|
| 341 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can make topics appear at the top of the topic list. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 342 |
+
"type": "string"
|
| 343 |
+
},
|
| 344 |
+
"whoCanMarkDuplicate": {
|
| 345 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as a duplicate of another topic. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 346 |
+
"type": "string"
|
| 347 |
+
},
|
| 348 |
+
"whoCanMarkFavoriteReplyOnAnyTopic": {
|
| 349 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark any other user's post as a favorite reply. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 350 |
+
"type": "string"
|
| 351 |
+
},
|
| 352 |
+
"whoCanMarkFavoriteReplyOnOwnTopic": {
|
| 353 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 354 |
+
"type": "string"
|
| 355 |
+
},
|
| 356 |
+
"whoCanMarkNoResponseNeeded": {
|
| 357 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as not needing a response. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 358 |
+
"type": "string"
|
| 359 |
+
},
|
| 360 |
+
"whoCanModerateContent": {
|
| 361 |
+
"description": "Specifies who can moderate content. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 362 |
+
"type": "string"
|
| 363 |
+
},
|
| 364 |
+
"whoCanModerateMembers": {
|
| 365 |
+
"description": "Specifies who can manage members. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 366 |
+
"type": "string"
|
| 367 |
+
},
|
| 368 |
+
"whoCanModifyMembers": {
|
| 369 |
+
"description": "Deprecated. This is merged into the new whoCanModerateMembers setting. Specifies who can change group members' roles. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 370 |
+
"type": "string"
|
| 371 |
+
},
|
| 372 |
+
"whoCanModifyTagsAndCategories": {
|
| 373 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to change tags and categories. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 374 |
+
"type": "string"
|
| 375 |
+
},
|
| 376 |
+
"whoCanMoveTopicsIn": {
|
| 377 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics into the group or forum. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 378 |
+
"type": "string"
|
| 379 |
+
},
|
| 380 |
+
"whoCanMoveTopicsOut": {
|
| 381 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics out of the group or forum. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 382 |
+
"type": "string"
|
| 383 |
+
},
|
| 384 |
+
"whoCanPostAnnouncements": {
|
| 385 |
+
"description": "Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can post announcements, a special topic type. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- OWNERS_ONLY \n- NONE",
|
| 386 |
+
"type": "string"
|
| 387 |
+
},
|
| 388 |
+
"whoCanPostMessage": {
|
| 389 |
+
"description": "Permissions to post messages. Possible values are: \n- NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group. \n- When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error. \n- If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST. \n- ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages. \n- ALL_MEMBERS_CAN_POST: Any group member can post a message. \n- ALL_OWNERS_CAN_POST: Only group owners can post a message. \n- ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message. \n- ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message. Note: When whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.",
|
| 390 |
+
"type": "string"
|
| 391 |
+
},
|
| 392 |
+
"whoCanTakeTopics": {
|
| 393 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to take topics in a forum. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 394 |
+
"type": "string"
|
| 395 |
+
},
|
| 396 |
+
"whoCanUnassignTopic": {
|
| 397 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unassign any topic in a forum. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 398 |
+
"type": "string"
|
| 399 |
+
},
|
| 400 |
+
"whoCanUnmarkFavoriteReplyOnAnyTopic": {
|
| 401 |
+
"description": "Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unmark any post from a favorite reply. Possible values are: \n- ALL_MEMBERS \n- OWNERS_AND_MANAGERS \n- MANAGERS_ONLY \n- OWNERS_ONLY \n- NONE",
|
| 402 |
+
"type": "string"
|
| 403 |
+
},
|
| 404 |
+
"whoCanViewGroup": {
|
| 405 |
+
"description": "Permissions to view group messages. Possible values are: \n- ANYONE_CAN_VIEW: Any Internet user can view the group's messages. \n- ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages. \n- ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages. \n- ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.",
|
| 406 |
+
"type": "string"
|
| 407 |
+
},
|
| 408 |
+
"whoCanViewMembership": {
|
| 409 |
+
"description": "Permissions to view membership. Possible values are: \n- ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.\nIf a group already has external members, those members can still send email to this group.\n \n- ALL_MEMBERS_CAN_VIEW: The group members can view the group members list. \n- ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.",
|
| 410 |
+
"type": "string"
|
| 411 |
+
}
|
| 412 |
+
},
|
| 413 |
+
"type": "object"
|
| 414 |
+
}
|
| 415 |
+
},
|
| 416 |
+
"servicePath": "groups/v1/groups/",
|
| 417 |
+
"title": "Groups Settings API",
|
| 418 |
+
"version": "v1"
|
| 419 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/iam.v2.json
ADDED
|
@@ -0,0 +1,880 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://iam.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "Iam",
|
| 15 |
+
"description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. ",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/iam/",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "iam:v2",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://iam.mtls.googleapis.com/",
|
| 26 |
+
"name": "iam",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"policies": {
|
| 109 |
+
"methods": {
|
| 110 |
+
"createPolicy": {
|
| 111 |
+
"description": "Creates a policy.",
|
| 112 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}",
|
| 113 |
+
"httpMethod": "POST",
|
| 114 |
+
"id": "iam.policies.createPolicy",
|
| 115 |
+
"parameterOrder": [
|
| 116 |
+
"parent"
|
| 117 |
+
],
|
| 118 |
+
"parameters": {
|
| 119 |
+
"parent": {
|
| 120 |
+
"description": "Required. The resource that the policy is attached to, along with the kind of policy to create. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.",
|
| 121 |
+
"location": "path",
|
| 122 |
+
"pattern": "^policies/[^/]+/[^/]+$",
|
| 123 |
+
"required": true,
|
| 124 |
+
"type": "string"
|
| 125 |
+
},
|
| 126 |
+
"policyId": {
|
| 127 |
+
"description": "The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (`-`) and periods (`.`). The first character must be a lowercase letter.",
|
| 128 |
+
"location": "query",
|
| 129 |
+
"type": "string"
|
| 130 |
+
}
|
| 131 |
+
},
|
| 132 |
+
"path": "v2/{+parent}",
|
| 133 |
+
"request": {
|
| 134 |
+
"$ref": "GoogleIamV2Policy"
|
| 135 |
+
},
|
| 136 |
+
"response": {
|
| 137 |
+
"$ref": "GoogleLongrunningOperation"
|
| 138 |
+
},
|
| 139 |
+
"scopes": [
|
| 140 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 141 |
+
]
|
| 142 |
+
},
|
| 143 |
+
"delete": {
|
| 144 |
+
"description": "Deletes a policy. This action is permanent.",
|
| 145 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}/{policiesId2}",
|
| 146 |
+
"httpMethod": "DELETE",
|
| 147 |
+
"id": "iam.policies.delete",
|
| 148 |
+
"parameterOrder": [
|
| 149 |
+
"name"
|
| 150 |
+
],
|
| 151 |
+
"parameters": {
|
| 152 |
+
"etag": {
|
| 153 |
+
"description": "Optional. The expected `etag` of the policy to delete. If the value does not match the value that is stored in IAM, the request fails with a `409` error code and `ABORTED` status. If you omit this field, the policy is deleted regardless of its current `etag`.",
|
| 154 |
+
"location": "query",
|
| 155 |
+
"type": "string"
|
| 156 |
+
},
|
| 157 |
+
"name": {
|
| 158 |
+
"description": "Required. The resource name of the policy to delete. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.",
|
| 159 |
+
"location": "path",
|
| 160 |
+
"pattern": "^policies/[^/]+/[^/]+/[^/]+$",
|
| 161 |
+
"required": true,
|
| 162 |
+
"type": "string"
|
| 163 |
+
}
|
| 164 |
+
},
|
| 165 |
+
"path": "v2/{+name}",
|
| 166 |
+
"response": {
|
| 167 |
+
"$ref": "GoogleLongrunningOperation"
|
| 168 |
+
},
|
| 169 |
+
"scopes": [
|
| 170 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 171 |
+
]
|
| 172 |
+
},
|
| 173 |
+
"get": {
|
| 174 |
+
"description": "Gets a policy.",
|
| 175 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}/{policiesId2}",
|
| 176 |
+
"httpMethod": "GET",
|
| 177 |
+
"id": "iam.policies.get",
|
| 178 |
+
"parameterOrder": [
|
| 179 |
+
"name"
|
| 180 |
+
],
|
| 181 |
+
"parameters": {
|
| 182 |
+
"name": {
|
| 183 |
+
"description": "Required. The resource name of the policy to retrieve. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.",
|
| 184 |
+
"location": "path",
|
| 185 |
+
"pattern": "^policies/[^/]+/[^/]+/[^/]+$",
|
| 186 |
+
"required": true,
|
| 187 |
+
"type": "string"
|
| 188 |
+
}
|
| 189 |
+
},
|
| 190 |
+
"path": "v2/{+name}",
|
| 191 |
+
"response": {
|
| 192 |
+
"$ref": "GoogleIamV2Policy"
|
| 193 |
+
},
|
| 194 |
+
"scopes": [
|
| 195 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 196 |
+
]
|
| 197 |
+
},
|
| 198 |
+
"listPolicies": {
|
| 199 |
+
"description": "Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.",
|
| 200 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}",
|
| 201 |
+
"httpMethod": "GET",
|
| 202 |
+
"id": "iam.policies.listPolicies",
|
| 203 |
+
"parameterOrder": [
|
| 204 |
+
"parent"
|
| 205 |
+
],
|
| 206 |
+
"parameters": {
|
| 207 |
+
"pageSize": {
|
| 208 |
+
"description": "The maximum number of policies to return. IAM ignores this value and uses the value 1000.",
|
| 209 |
+
"format": "int32",
|
| 210 |
+
"location": "query",
|
| 211 |
+
"type": "integer"
|
| 212 |
+
},
|
| 213 |
+
"pageToken": {
|
| 214 |
+
"description": "A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.",
|
| 215 |
+
"location": "query",
|
| 216 |
+
"type": "string"
|
| 217 |
+
},
|
| 218 |
+
"parent": {
|
| 219 |
+
"description": "Required. The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.",
|
| 220 |
+
"location": "path",
|
| 221 |
+
"pattern": "^policies/[^/]+/[^/]+$",
|
| 222 |
+
"required": true,
|
| 223 |
+
"type": "string"
|
| 224 |
+
}
|
| 225 |
+
},
|
| 226 |
+
"path": "v2/{+parent}",
|
| 227 |
+
"response": {
|
| 228 |
+
"$ref": "GoogleIamV2ListPoliciesResponse"
|
| 229 |
+
},
|
| 230 |
+
"scopes": [
|
| 231 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 232 |
+
]
|
| 233 |
+
},
|
| 234 |
+
"update": {
|
| 235 |
+
"description": "Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop: 1. Use GetPolicy to read the current version of the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to write the updated policy. This pattern helps prevent conflicts between concurrent updates.",
|
| 236 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}/{policiesId2}",
|
| 237 |
+
"httpMethod": "PUT",
|
| 238 |
+
"id": "iam.policies.update",
|
| 239 |
+
"parameterOrder": [
|
| 240 |
+
"name"
|
| 241 |
+
],
|
| 242 |
+
"parameters": {
|
| 243 |
+
"name": {
|
| 244 |
+
"description": "Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.",
|
| 245 |
+
"location": "path",
|
| 246 |
+
"pattern": "^policies/[^/]+/[^/]+/[^/]+$",
|
| 247 |
+
"required": true,
|
| 248 |
+
"type": "string"
|
| 249 |
+
}
|
| 250 |
+
},
|
| 251 |
+
"path": "v2/{+name}",
|
| 252 |
+
"request": {
|
| 253 |
+
"$ref": "GoogleIamV2Policy"
|
| 254 |
+
},
|
| 255 |
+
"response": {
|
| 256 |
+
"$ref": "GoogleLongrunningOperation"
|
| 257 |
+
},
|
| 258 |
+
"scopes": [
|
| 259 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 260 |
+
]
|
| 261 |
+
}
|
| 262 |
+
},
|
| 263 |
+
"resources": {
|
| 264 |
+
"operations": {
|
| 265 |
+
"methods": {
|
| 266 |
+
"get": {
|
| 267 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 268 |
+
"flatPath": "v2/policies/{policiesId}/{policiesId1}/{policiesId2}/operations/{operationsId}",
|
| 269 |
+
"httpMethod": "GET",
|
| 270 |
+
"id": "iam.policies.operations.get",
|
| 271 |
+
"parameterOrder": [
|
| 272 |
+
"name"
|
| 273 |
+
],
|
| 274 |
+
"parameters": {
|
| 275 |
+
"name": {
|
| 276 |
+
"description": "The name of the operation resource.",
|
| 277 |
+
"location": "path",
|
| 278 |
+
"pattern": "^policies/[^/]+/[^/]+/[^/]+/operations/[^/]+$",
|
| 279 |
+
"required": true,
|
| 280 |
+
"type": "string"
|
| 281 |
+
}
|
| 282 |
+
},
|
| 283 |
+
"path": "v2/{+name}",
|
| 284 |
+
"response": {
|
| 285 |
+
"$ref": "GoogleLongrunningOperation"
|
| 286 |
+
},
|
| 287 |
+
"scopes": [
|
| 288 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 289 |
+
]
|
| 290 |
+
}
|
| 291 |
+
}
|
| 292 |
+
}
|
| 293 |
+
}
|
| 294 |
+
}
|
| 295 |
+
},
|
| 296 |
+
"revision": "20241114",
|
| 297 |
+
"rootUrl": "https://iam.googleapis.com/",
|
| 298 |
+
"schemas": {
|
| 299 |
+
"CloudControl2SharedOperationsReconciliationOperationMetadata": {
|
| 300 |
+
"description": "Operation metadata returned by the CLH during resource state reconciliation.",
|
| 301 |
+
"id": "CloudControl2SharedOperationsReconciliationOperationMetadata",
|
| 302 |
+
"properties": {
|
| 303 |
+
"deleteResource": {
|
| 304 |
+
"deprecated": true,
|
| 305 |
+
"description": "DEPRECATED. Use exclusive_action instead.",
|
| 306 |
+
"type": "boolean"
|
| 307 |
+
},
|
| 308 |
+
"exclusiveAction": {
|
| 309 |
+
"description": "Excluisive action returned by the CLH.",
|
| 310 |
+
"enum": [
|
| 311 |
+
"UNKNOWN_REPAIR_ACTION",
|
| 312 |
+
"DELETE",
|
| 313 |
+
"RETRY"
|
| 314 |
+
],
|
| 315 |
+
"enumDeprecated": [
|
| 316 |
+
false,
|
| 317 |
+
true,
|
| 318 |
+
false
|
| 319 |
+
],
|
| 320 |
+
"enumDescriptions": [
|
| 321 |
+
"Unknown repair action.",
|
| 322 |
+
"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.",
|
| 323 |
+
"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource."
|
| 324 |
+
],
|
| 325 |
+
"type": "string"
|
| 326 |
+
}
|
| 327 |
+
},
|
| 328 |
+
"type": "object"
|
| 329 |
+
},
|
| 330 |
+
"GoogleCloudCommonOperationMetadata": {
|
| 331 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 332 |
+
"id": "GoogleCloudCommonOperationMetadata",
|
| 333 |
+
"properties": {
|
| 334 |
+
"apiVersion": {
|
| 335 |
+
"description": "Output only. API version used to start the operation.",
|
| 336 |
+
"readOnly": true,
|
| 337 |
+
"type": "string"
|
| 338 |
+
},
|
| 339 |
+
"cancelRequested": {
|
| 340 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
|
| 341 |
+
"readOnly": true,
|
| 342 |
+
"type": "boolean"
|
| 343 |
+
},
|
| 344 |
+
"createTime": {
|
| 345 |
+
"description": "Output only. The time the operation was created.",
|
| 346 |
+
"format": "google-datetime",
|
| 347 |
+
"readOnly": true,
|
| 348 |
+
"type": "string"
|
| 349 |
+
},
|
| 350 |
+
"endTime": {
|
| 351 |
+
"description": "Output only. The time the operation finished running.",
|
| 352 |
+
"format": "google-datetime",
|
| 353 |
+
"readOnly": true,
|
| 354 |
+
"type": "string"
|
| 355 |
+
},
|
| 356 |
+
"statusDetail": {
|
| 357 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 358 |
+
"readOnly": true,
|
| 359 |
+
"type": "string"
|
| 360 |
+
},
|
| 361 |
+
"target": {
|
| 362 |
+
"description": "Output only. Server-defined resource path for the target of the operation.",
|
| 363 |
+
"readOnly": true,
|
| 364 |
+
"type": "string"
|
| 365 |
+
},
|
| 366 |
+
"verb": {
|
| 367 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 368 |
+
"readOnly": true,
|
| 369 |
+
"type": "string"
|
| 370 |
+
}
|
| 371 |
+
},
|
| 372 |
+
"type": "object"
|
| 373 |
+
},
|
| 374 |
+
"GoogleIamAdminV1AuditData": {
|
| 375 |
+
"description": "Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.",
|
| 376 |
+
"id": "GoogleIamAdminV1AuditData",
|
| 377 |
+
"properties": {
|
| 378 |
+
"permissionDelta": {
|
| 379 |
+
"$ref": "GoogleIamAdminV1AuditDataPermissionDelta",
|
| 380 |
+
"description": "The permission_delta when when creating or updating a Role."
|
| 381 |
+
}
|
| 382 |
+
},
|
| 383 |
+
"type": "object"
|
| 384 |
+
},
|
| 385 |
+
"GoogleIamAdminV1AuditDataPermissionDelta": {
|
| 386 |
+
"description": "A PermissionDelta message to record the added_permissions and removed_permissions inside a role.",
|
| 387 |
+
"id": "GoogleIamAdminV1AuditDataPermissionDelta",
|
| 388 |
+
"properties": {
|
| 389 |
+
"addedPermissions": {
|
| 390 |
+
"description": "Added permissions.",
|
| 391 |
+
"items": {
|
| 392 |
+
"type": "string"
|
| 393 |
+
},
|
| 394 |
+
"type": "array"
|
| 395 |
+
},
|
| 396 |
+
"removedPermissions": {
|
| 397 |
+
"description": "Removed permissions.",
|
| 398 |
+
"items": {
|
| 399 |
+
"type": "string"
|
| 400 |
+
},
|
| 401 |
+
"type": "array"
|
| 402 |
+
}
|
| 403 |
+
},
|
| 404 |
+
"type": "object"
|
| 405 |
+
},
|
| 406 |
+
"GoogleIamV1BindingDelta": {
|
| 407 |
+
"description": "One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.",
|
| 408 |
+
"id": "GoogleIamV1BindingDelta",
|
| 409 |
+
"properties": {
|
| 410 |
+
"action": {
|
| 411 |
+
"description": "The action that was performed on a Binding. Required",
|
| 412 |
+
"enum": [
|
| 413 |
+
"ACTION_UNSPECIFIED",
|
| 414 |
+
"ADD",
|
| 415 |
+
"REMOVE"
|
| 416 |
+
],
|
| 417 |
+
"enumDescriptions": [
|
| 418 |
+
"Unspecified.",
|
| 419 |
+
"Addition of a Binding.",
|
| 420 |
+
"Removal of a Binding."
|
| 421 |
+
],
|
| 422 |
+
"type": "string"
|
| 423 |
+
},
|
| 424 |
+
"condition": {
|
| 425 |
+
"$ref": "GoogleTypeExpr",
|
| 426 |
+
"description": "The condition that is associated with this binding."
|
| 427 |
+
},
|
| 428 |
+
"member": {
|
| 429 |
+
"description": "A single identity requesting access for a Google Cloud resource. Follows the same format of Binding.members. Required",
|
| 430 |
+
"type": "string"
|
| 431 |
+
},
|
| 432 |
+
"role": {
|
| 433 |
+
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required",
|
| 434 |
+
"type": "string"
|
| 435 |
+
}
|
| 436 |
+
},
|
| 437 |
+
"type": "object"
|
| 438 |
+
},
|
| 439 |
+
"GoogleIamV1LoggingAuditData": {
|
| 440 |
+
"description": "Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.",
|
| 441 |
+
"id": "GoogleIamV1LoggingAuditData",
|
| 442 |
+
"properties": {
|
| 443 |
+
"policyDelta": {
|
| 444 |
+
"$ref": "GoogleIamV1PolicyDelta",
|
| 445 |
+
"description": "Policy delta between the original policy and the newly set policy."
|
| 446 |
+
}
|
| 447 |
+
},
|
| 448 |
+
"type": "object"
|
| 449 |
+
},
|
| 450 |
+
"GoogleIamV1PolicyDelta": {
|
| 451 |
+
"description": "The difference delta between two policies.",
|
| 452 |
+
"id": "GoogleIamV1PolicyDelta",
|
| 453 |
+
"properties": {
|
| 454 |
+
"bindingDeltas": {
|
| 455 |
+
"description": "The delta for Bindings between two policies.",
|
| 456 |
+
"items": {
|
| 457 |
+
"$ref": "GoogleIamV1BindingDelta"
|
| 458 |
+
},
|
| 459 |
+
"type": "array"
|
| 460 |
+
}
|
| 461 |
+
},
|
| 462 |
+
"type": "object"
|
| 463 |
+
},
|
| 464 |
+
"GoogleIamV1betaWorkloadIdentityPoolOperationMetadata": {
|
| 465 |
+
"description": "Metadata for long-running WorkloadIdentityPool operations.",
|
| 466 |
+
"id": "GoogleIamV1betaWorkloadIdentityPoolOperationMetadata",
|
| 467 |
+
"properties": {},
|
| 468 |
+
"type": "object"
|
| 469 |
+
},
|
| 470 |
+
"GoogleIamV2DenyRule": {
|
| 471 |
+
"description": "A deny rule in an IAM deny policy.",
|
| 472 |
+
"id": "GoogleIamV2DenyRule",
|
| 473 |
+
"properties": {
|
| 474 |
+
"denialCondition": {
|
| 475 |
+
"$ref": "GoogleTypeExpr",
|
| 476 |
+
"description": "The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to `true`, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate [resource tags](https://cloud.google.com/iam/help/conditions/resource-tags). Other functions and operators are not supported."
|
| 477 |
+
},
|
| 478 |
+
"deniedPermissions": {
|
| 479 |
+
"description": "The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`.",
|
| 480 |
+
"items": {
|
| 481 |
+
"type": "string"
|
| 482 |
+
},
|
| 483 |
+
"type": "array"
|
| 484 |
+
},
|
| 485 |
+
"deniedPrincipals": {
|
| 486 |
+
"description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 487 |
+
"items": {
|
| 488 |
+
"type": "string"
|
| 489 |
+
},
|
| 490 |
+
"type": "array"
|
| 491 |
+
},
|
| 492 |
+
"exceptionPermissions": {
|
| 493 |
+
"description": "Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`.",
|
| 494 |
+
"items": {
|
| 495 |
+
"type": "string"
|
| 496 |
+
},
|
| 497 |
+
"type": "array"
|
| 498 |
+
},
|
| 499 |
+
"exceptionPrincipals": {
|
| 500 |
+
"description": "The identities that are excluded from the deny rule, even if they are listed in the `denied_principals`. For example, you could add a Google group to the `denied_principals`, then exclude specific users who belong to that group. This field can contain the same values as the `denied_principals` field, excluding `principalSet://goog/public:all`, which represents all users on the internet.",
|
| 501 |
+
"items": {
|
| 502 |
+
"type": "string"
|
| 503 |
+
},
|
| 504 |
+
"type": "array"
|
| 505 |
+
}
|
| 506 |
+
},
|
| 507 |
+
"type": "object"
|
| 508 |
+
},
|
| 509 |
+
"GoogleIamV2ListPoliciesResponse": {
|
| 510 |
+
"description": "Response message for `ListPolicies`.",
|
| 511 |
+
"id": "GoogleIamV2ListPoliciesResponse",
|
| 512 |
+
"properties": {
|
| 513 |
+
"nextPageToken": {
|
| 514 |
+
"description": "A page token that you can use in a ListPoliciesRequest to retrieve the next page. If this field is omitted, there are no additional pages.",
|
| 515 |
+
"type": "string"
|
| 516 |
+
},
|
| 517 |
+
"policies": {
|
| 518 |
+
"description": "Metadata for the policies that are attached to the resource.",
|
| 519 |
+
"items": {
|
| 520 |
+
"$ref": "GoogleIamV2Policy"
|
| 521 |
+
},
|
| 522 |
+
"type": "array"
|
| 523 |
+
}
|
| 524 |
+
},
|
| 525 |
+
"type": "object"
|
| 526 |
+
},
|
| 527 |
+
"GoogleIamV2Policy": {
|
| 528 |
+
"description": "Data for an IAM policy.",
|
| 529 |
+
"id": "GoogleIamV2Policy",
|
| 530 |
+
"properties": {
|
| 531 |
+
"annotations": {
|
| 532 |
+
"additionalProperties": {
|
| 533 |
+
"type": "string"
|
| 534 |
+
},
|
| 535 |
+
"description": "A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters.",
|
| 536 |
+
"type": "object"
|
| 537 |
+
},
|
| 538 |
+
"createTime": {
|
| 539 |
+
"description": "Output only. The time when the `Policy` was created.",
|
| 540 |
+
"format": "google-datetime",
|
| 541 |
+
"readOnly": true,
|
| 542 |
+
"type": "string"
|
| 543 |
+
},
|
| 544 |
+
"deleteTime": {
|
| 545 |
+
"description": "Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.",
|
| 546 |
+
"format": "google-datetime",
|
| 547 |
+
"readOnly": true,
|
| 548 |
+
"type": "string"
|
| 549 |
+
},
|
| 550 |
+
"displayName": {
|
| 551 |
+
"description": "A user-specified description of the `Policy`. This value can be up to 63 characters.",
|
| 552 |
+
"type": "string"
|
| 553 |
+
},
|
| 554 |
+
"etag": {
|
| 555 |
+
"description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.",
|
| 556 |
+
"type": "string"
|
| 557 |
+
},
|
| 558 |
+
"kind": {
|
| 559 |
+
"description": "Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.",
|
| 560 |
+
"readOnly": true,
|
| 561 |
+
"type": "string"
|
| 562 |
+
},
|
| 563 |
+
"name": {
|
| 564 |
+
"description": "Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.",
|
| 565 |
+
"type": "string"
|
| 566 |
+
},
|
| 567 |
+
"rules": {
|
| 568 |
+
"description": "A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`.",
|
| 569 |
+
"items": {
|
| 570 |
+
"$ref": "GoogleIamV2PolicyRule"
|
| 571 |
+
},
|
| 572 |
+
"type": "array"
|
| 573 |
+
},
|
| 574 |
+
"uid": {
|
| 575 |
+
"description": "Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.",
|
| 576 |
+
"type": "string"
|
| 577 |
+
},
|
| 578 |
+
"updateTime": {
|
| 579 |
+
"description": "Output only. The time when the `Policy` was last updated.",
|
| 580 |
+
"format": "google-datetime",
|
| 581 |
+
"readOnly": true,
|
| 582 |
+
"type": "string"
|
| 583 |
+
}
|
| 584 |
+
},
|
| 585 |
+
"type": "object"
|
| 586 |
+
},
|
| 587 |
+
"GoogleIamV2PolicyOperationMetadata": {
|
| 588 |
+
"description": "Metadata for long-running `Policy` operations.",
|
| 589 |
+
"id": "GoogleIamV2PolicyOperationMetadata",
|
| 590 |
+
"properties": {
|
| 591 |
+
"createTime": {
|
| 592 |
+
"description": "Timestamp when the `google.longrunning.Operation` was created.",
|
| 593 |
+
"format": "google-datetime",
|
| 594 |
+
"type": "string"
|
| 595 |
+
}
|
| 596 |
+
},
|
| 597 |
+
"type": "object"
|
| 598 |
+
},
|
| 599 |
+
"GoogleIamV2PolicyRule": {
|
| 600 |
+
"description": "A single rule in a `Policy`.",
|
| 601 |
+
"id": "GoogleIamV2PolicyRule",
|
| 602 |
+
"properties": {
|
| 603 |
+
"denyRule": {
|
| 604 |
+
"$ref": "GoogleIamV2DenyRule",
|
| 605 |
+
"description": "A rule for a deny policy."
|
| 606 |
+
},
|
| 607 |
+
"description": {
|
| 608 |
+
"description": "A user-specified description of the rule. This value can be up to 256 characters.",
|
| 609 |
+
"type": "string"
|
| 610 |
+
}
|
| 611 |
+
},
|
| 612 |
+
"type": "object"
|
| 613 |
+
},
|
| 614 |
+
"GoogleIamV3OperationMetadata": {
|
| 615 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 616 |
+
"id": "GoogleIamV3OperationMetadata",
|
| 617 |
+
"properties": {
|
| 618 |
+
"apiVersion": {
|
| 619 |
+
"description": "Output only. API version used to start the operation.",
|
| 620 |
+
"readOnly": true,
|
| 621 |
+
"type": "string"
|
| 622 |
+
},
|
| 623 |
+
"createTime": {
|
| 624 |
+
"description": "Output only. The time the operation was created.",
|
| 625 |
+
"format": "google-datetime",
|
| 626 |
+
"readOnly": true,
|
| 627 |
+
"type": "string"
|
| 628 |
+
},
|
| 629 |
+
"endTime": {
|
| 630 |
+
"description": "Output only. The time the operation finished running.",
|
| 631 |
+
"format": "google-datetime",
|
| 632 |
+
"readOnly": true,
|
| 633 |
+
"type": "string"
|
| 634 |
+
},
|
| 635 |
+
"requestedCancellation": {
|
| 636 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 637 |
+
"readOnly": true,
|
| 638 |
+
"type": "boolean"
|
| 639 |
+
},
|
| 640 |
+
"statusMessage": {
|
| 641 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 642 |
+
"readOnly": true,
|
| 643 |
+
"type": "string"
|
| 644 |
+
},
|
| 645 |
+
"target": {
|
| 646 |
+
"description": "Output only. Server-defined resource path for the target of the",
|
| 647 |
+
"readOnly": true,
|
| 648 |
+
"type": "string"
|
| 649 |
+
},
|
| 650 |
+
"verb": {
|
| 651 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 652 |
+
"readOnly": true,
|
| 653 |
+
"type": "string"
|
| 654 |
+
}
|
| 655 |
+
},
|
| 656 |
+
"type": "object"
|
| 657 |
+
},
|
| 658 |
+
"GoogleIamV3alphaOperationMetadata": {
|
| 659 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 660 |
+
"id": "GoogleIamV3alphaOperationMetadata",
|
| 661 |
+
"properties": {
|
| 662 |
+
"apiVersion": {
|
| 663 |
+
"description": "Output only. API version used to start the operation.",
|
| 664 |
+
"readOnly": true,
|
| 665 |
+
"type": "string"
|
| 666 |
+
},
|
| 667 |
+
"createTime": {
|
| 668 |
+
"description": "Output only. The time the operation was created.",
|
| 669 |
+
"format": "google-datetime",
|
| 670 |
+
"readOnly": true,
|
| 671 |
+
"type": "string"
|
| 672 |
+
},
|
| 673 |
+
"endTime": {
|
| 674 |
+
"description": "Output only. The time the operation finished running.",
|
| 675 |
+
"format": "google-datetime",
|
| 676 |
+
"readOnly": true,
|
| 677 |
+
"type": "string"
|
| 678 |
+
},
|
| 679 |
+
"requestedCancellation": {
|
| 680 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 681 |
+
"readOnly": true,
|
| 682 |
+
"type": "boolean"
|
| 683 |
+
},
|
| 684 |
+
"statusMessage": {
|
| 685 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 686 |
+
"readOnly": true,
|
| 687 |
+
"type": "string"
|
| 688 |
+
},
|
| 689 |
+
"target": {
|
| 690 |
+
"description": "Output only. Server-defined resource path for the target of the",
|
| 691 |
+
"readOnly": true,
|
| 692 |
+
"type": "string"
|
| 693 |
+
},
|
| 694 |
+
"verb": {
|
| 695 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 696 |
+
"readOnly": true,
|
| 697 |
+
"type": "string"
|
| 698 |
+
}
|
| 699 |
+
},
|
| 700 |
+
"type": "object"
|
| 701 |
+
},
|
| 702 |
+
"GoogleIamV3betaOperationMetadata": {
|
| 703 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 704 |
+
"id": "GoogleIamV3betaOperationMetadata",
|
| 705 |
+
"properties": {
|
| 706 |
+
"apiVersion": {
|
| 707 |
+
"description": "Output only. API version used to start the operation.",
|
| 708 |
+
"readOnly": true,
|
| 709 |
+
"type": "string"
|
| 710 |
+
},
|
| 711 |
+
"createTime": {
|
| 712 |
+
"description": "Output only. The time the operation was created.",
|
| 713 |
+
"format": "google-datetime",
|
| 714 |
+
"readOnly": true,
|
| 715 |
+
"type": "string"
|
| 716 |
+
},
|
| 717 |
+
"endTime": {
|
| 718 |
+
"description": "Output only. The time the operation finished running.",
|
| 719 |
+
"format": "google-datetime",
|
| 720 |
+
"readOnly": true,
|
| 721 |
+
"type": "string"
|
| 722 |
+
},
|
| 723 |
+
"requestedCancellation": {
|
| 724 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 725 |
+
"readOnly": true,
|
| 726 |
+
"type": "boolean"
|
| 727 |
+
},
|
| 728 |
+
"statusMessage": {
|
| 729 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 730 |
+
"readOnly": true,
|
| 731 |
+
"type": "string"
|
| 732 |
+
},
|
| 733 |
+
"target": {
|
| 734 |
+
"description": "Output only. Server-defined resource path for the target of the",
|
| 735 |
+
"readOnly": true,
|
| 736 |
+
"type": "string"
|
| 737 |
+
},
|
| 738 |
+
"verb": {
|
| 739 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 740 |
+
"readOnly": true,
|
| 741 |
+
"type": "string"
|
| 742 |
+
}
|
| 743 |
+
},
|
| 744 |
+
"type": "object"
|
| 745 |
+
},
|
| 746 |
+
"GoogleIamV3mainOperationMetadata": {
|
| 747 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 748 |
+
"id": "GoogleIamV3mainOperationMetadata",
|
| 749 |
+
"properties": {
|
| 750 |
+
"apiVersion": {
|
| 751 |
+
"description": "Output only. API version used to start the operation.",
|
| 752 |
+
"readOnly": true,
|
| 753 |
+
"type": "string"
|
| 754 |
+
},
|
| 755 |
+
"createTime": {
|
| 756 |
+
"description": "Output only. The time the operation was created.",
|
| 757 |
+
"format": "google-datetime",
|
| 758 |
+
"readOnly": true,
|
| 759 |
+
"type": "string"
|
| 760 |
+
},
|
| 761 |
+
"endTime": {
|
| 762 |
+
"description": "Output only. The time the operation finished running.",
|
| 763 |
+
"format": "google-datetime",
|
| 764 |
+
"readOnly": true,
|
| 765 |
+
"type": "string"
|
| 766 |
+
},
|
| 767 |
+
"requestedCancellation": {
|
| 768 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 769 |
+
"readOnly": true,
|
| 770 |
+
"type": "boolean"
|
| 771 |
+
},
|
| 772 |
+
"statusMessage": {
|
| 773 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 774 |
+
"readOnly": true,
|
| 775 |
+
"type": "string"
|
| 776 |
+
},
|
| 777 |
+
"target": {
|
| 778 |
+
"description": "Output only. Server-defined resource path for the target of the",
|
| 779 |
+
"readOnly": true,
|
| 780 |
+
"type": "string"
|
| 781 |
+
},
|
| 782 |
+
"verb": {
|
| 783 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 784 |
+
"readOnly": true,
|
| 785 |
+
"type": "string"
|
| 786 |
+
}
|
| 787 |
+
},
|
| 788 |
+
"type": "object"
|
| 789 |
+
},
|
| 790 |
+
"GoogleLongrunningOperation": {
|
| 791 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 792 |
+
"id": "GoogleLongrunningOperation",
|
| 793 |
+
"properties": {
|
| 794 |
+
"done": {
|
| 795 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 796 |
+
"type": "boolean"
|
| 797 |
+
},
|
| 798 |
+
"error": {
|
| 799 |
+
"$ref": "GoogleRpcStatus",
|
| 800 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 801 |
+
},
|
| 802 |
+
"metadata": {
|
| 803 |
+
"additionalProperties": {
|
| 804 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 805 |
+
"type": "any"
|
| 806 |
+
},
|
| 807 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 808 |
+
"type": "object"
|
| 809 |
+
},
|
| 810 |
+
"name": {
|
| 811 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 812 |
+
"type": "string"
|
| 813 |
+
},
|
| 814 |
+
"response": {
|
| 815 |
+
"additionalProperties": {
|
| 816 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 817 |
+
"type": "any"
|
| 818 |
+
},
|
| 819 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 820 |
+
"type": "object"
|
| 821 |
+
}
|
| 822 |
+
},
|
| 823 |
+
"type": "object"
|
| 824 |
+
},
|
| 825 |
+
"GoogleRpcStatus": {
|
| 826 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 827 |
+
"id": "GoogleRpcStatus",
|
| 828 |
+
"properties": {
|
| 829 |
+
"code": {
|
| 830 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 831 |
+
"format": "int32",
|
| 832 |
+
"type": "integer"
|
| 833 |
+
},
|
| 834 |
+
"details": {
|
| 835 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 836 |
+
"items": {
|
| 837 |
+
"additionalProperties": {
|
| 838 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 839 |
+
"type": "any"
|
| 840 |
+
},
|
| 841 |
+
"type": "object"
|
| 842 |
+
},
|
| 843 |
+
"type": "array"
|
| 844 |
+
},
|
| 845 |
+
"message": {
|
| 846 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 847 |
+
"type": "string"
|
| 848 |
+
}
|
| 849 |
+
},
|
| 850 |
+
"type": "object"
|
| 851 |
+
},
|
| 852 |
+
"GoogleTypeExpr": {
|
| 853 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 854 |
+
"id": "GoogleTypeExpr",
|
| 855 |
+
"properties": {
|
| 856 |
+
"description": {
|
| 857 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 858 |
+
"type": "string"
|
| 859 |
+
},
|
| 860 |
+
"expression": {
|
| 861 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 862 |
+
"type": "string"
|
| 863 |
+
},
|
| 864 |
+
"location": {
|
| 865 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 866 |
+
"type": "string"
|
| 867 |
+
},
|
| 868 |
+
"title": {
|
| 869 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 870 |
+
"type": "string"
|
| 871 |
+
}
|
| 872 |
+
},
|
| 873 |
+
"type": "object"
|
| 874 |
+
}
|
| 875 |
+
},
|
| 876 |
+
"servicePath": "",
|
| 877 |
+
"title": "Identity and Access Management (IAM) API",
|
| 878 |
+
"version": "v2",
|
| 879 |
+
"version_module": true
|
| 880 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/ids.v1.json
ADDED
|
@@ -0,0 +1,1074 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 6 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 7 |
+
}
|
| 8 |
+
}
|
| 9 |
+
}
|
| 10 |
+
},
|
| 11 |
+
"basePath": "",
|
| 12 |
+
"baseUrl": "https://ids.googleapis.com/",
|
| 13 |
+
"batchPath": "batch",
|
| 14 |
+
"canonicalName": "IDS",
|
| 15 |
+
"description": "Cloud IDS (Cloud Intrusion Detection System) detects malware, spyware, command-and-control attacks, and other network-based threats. Its security efficacy is industry leading, built with Palo Alto Networks technologies. When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks.",
|
| 16 |
+
"discoveryVersion": "v1",
|
| 17 |
+
"documentationLink": "https://cloud.google.com/",
|
| 18 |
+
"fullyEncodeReservedExpansion": true,
|
| 19 |
+
"icons": {
|
| 20 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 21 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 22 |
+
},
|
| 23 |
+
"id": "ids:v1",
|
| 24 |
+
"kind": "discovery#restDescription",
|
| 25 |
+
"mtlsRootUrl": "https://ids.mtls.googleapis.com/",
|
| 26 |
+
"name": "ids",
|
| 27 |
+
"ownerDomain": "google.com",
|
| 28 |
+
"ownerName": "Google",
|
| 29 |
+
"parameters": {
|
| 30 |
+
"$.xgafv": {
|
| 31 |
+
"description": "V1 error format.",
|
| 32 |
+
"enum": [
|
| 33 |
+
"1",
|
| 34 |
+
"2"
|
| 35 |
+
],
|
| 36 |
+
"enumDescriptions": [
|
| 37 |
+
"v1 error format",
|
| 38 |
+
"v2 error format"
|
| 39 |
+
],
|
| 40 |
+
"location": "query",
|
| 41 |
+
"type": "string"
|
| 42 |
+
},
|
| 43 |
+
"access_token": {
|
| 44 |
+
"description": "OAuth access token.",
|
| 45 |
+
"location": "query",
|
| 46 |
+
"type": "string"
|
| 47 |
+
},
|
| 48 |
+
"alt": {
|
| 49 |
+
"default": "json",
|
| 50 |
+
"description": "Data format for response.",
|
| 51 |
+
"enum": [
|
| 52 |
+
"json",
|
| 53 |
+
"media",
|
| 54 |
+
"proto"
|
| 55 |
+
],
|
| 56 |
+
"enumDescriptions": [
|
| 57 |
+
"Responses with Content-Type of application/json",
|
| 58 |
+
"Media download with context-dependent Content-Type",
|
| 59 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 60 |
+
],
|
| 61 |
+
"location": "query",
|
| 62 |
+
"type": "string"
|
| 63 |
+
},
|
| 64 |
+
"callback": {
|
| 65 |
+
"description": "JSONP",
|
| 66 |
+
"location": "query",
|
| 67 |
+
"type": "string"
|
| 68 |
+
},
|
| 69 |
+
"fields": {
|
| 70 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 71 |
+
"location": "query",
|
| 72 |
+
"type": "string"
|
| 73 |
+
},
|
| 74 |
+
"key": {
|
| 75 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 76 |
+
"location": "query",
|
| 77 |
+
"type": "string"
|
| 78 |
+
},
|
| 79 |
+
"oauth_token": {
|
| 80 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 81 |
+
"location": "query",
|
| 82 |
+
"type": "string"
|
| 83 |
+
},
|
| 84 |
+
"prettyPrint": {
|
| 85 |
+
"default": "true",
|
| 86 |
+
"description": "Returns response with indentations and line breaks.",
|
| 87 |
+
"location": "query",
|
| 88 |
+
"type": "boolean"
|
| 89 |
+
},
|
| 90 |
+
"quotaUser": {
|
| 91 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 92 |
+
"location": "query",
|
| 93 |
+
"type": "string"
|
| 94 |
+
},
|
| 95 |
+
"uploadType": {
|
| 96 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 97 |
+
"location": "query",
|
| 98 |
+
"type": "string"
|
| 99 |
+
},
|
| 100 |
+
"upload_protocol": {
|
| 101 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 102 |
+
"location": "query",
|
| 103 |
+
"type": "string"
|
| 104 |
+
}
|
| 105 |
+
},
|
| 106 |
+
"protocol": "rest",
|
| 107 |
+
"resources": {
|
| 108 |
+
"projects": {
|
| 109 |
+
"resources": {
|
| 110 |
+
"locations": {
|
| 111 |
+
"methods": {
|
| 112 |
+
"get": {
|
| 113 |
+
"description": "Gets information about a location.",
|
| 114 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
|
| 115 |
+
"httpMethod": "GET",
|
| 116 |
+
"id": "ids.projects.locations.get",
|
| 117 |
+
"parameterOrder": [
|
| 118 |
+
"name"
|
| 119 |
+
],
|
| 120 |
+
"parameters": {
|
| 121 |
+
"name": {
|
| 122 |
+
"description": "Resource name for the location.",
|
| 123 |
+
"location": "path",
|
| 124 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 125 |
+
"required": true,
|
| 126 |
+
"type": "string"
|
| 127 |
+
}
|
| 128 |
+
},
|
| 129 |
+
"path": "v1/{+name}",
|
| 130 |
+
"response": {
|
| 131 |
+
"$ref": "Location"
|
| 132 |
+
},
|
| 133 |
+
"scopes": [
|
| 134 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 135 |
+
]
|
| 136 |
+
},
|
| 137 |
+
"list": {
|
| 138 |
+
"description": "Lists information about the supported locations for this service.",
|
| 139 |
+
"flatPath": "v1/projects/{projectsId}/locations",
|
| 140 |
+
"httpMethod": "GET",
|
| 141 |
+
"id": "ids.projects.locations.list",
|
| 142 |
+
"parameterOrder": [
|
| 143 |
+
"name"
|
| 144 |
+
],
|
| 145 |
+
"parameters": {
|
| 146 |
+
"filter": {
|
| 147 |
+
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
|
| 148 |
+
"location": "query",
|
| 149 |
+
"type": "string"
|
| 150 |
+
},
|
| 151 |
+
"name": {
|
| 152 |
+
"description": "The resource that owns the locations collection, if applicable.",
|
| 153 |
+
"location": "path",
|
| 154 |
+
"pattern": "^projects/[^/]+$",
|
| 155 |
+
"required": true,
|
| 156 |
+
"type": "string"
|
| 157 |
+
},
|
| 158 |
+
"pageSize": {
|
| 159 |
+
"description": "The maximum number of results to return. If not set, the service selects a default.",
|
| 160 |
+
"format": "int32",
|
| 161 |
+
"location": "query",
|
| 162 |
+
"type": "integer"
|
| 163 |
+
},
|
| 164 |
+
"pageToken": {
|
| 165 |
+
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
|
| 166 |
+
"location": "query",
|
| 167 |
+
"type": "string"
|
| 168 |
+
}
|
| 169 |
+
},
|
| 170 |
+
"path": "v1/{+name}/locations",
|
| 171 |
+
"response": {
|
| 172 |
+
"$ref": "ListLocationsResponse"
|
| 173 |
+
},
|
| 174 |
+
"scopes": [
|
| 175 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 176 |
+
]
|
| 177 |
+
}
|
| 178 |
+
},
|
| 179 |
+
"resources": {
|
| 180 |
+
"endpoints": {
|
| 181 |
+
"methods": {
|
| 182 |
+
"create": {
|
| 183 |
+
"description": "Creates a new Endpoint in a given project and location.",
|
| 184 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
|
| 185 |
+
"httpMethod": "POST",
|
| 186 |
+
"id": "ids.projects.locations.endpoints.create",
|
| 187 |
+
"parameterOrder": [
|
| 188 |
+
"parent"
|
| 189 |
+
],
|
| 190 |
+
"parameters": {
|
| 191 |
+
"endpointId": {
|
| 192 |
+
"description": "Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.",
|
| 193 |
+
"location": "query",
|
| 194 |
+
"type": "string"
|
| 195 |
+
},
|
| 196 |
+
"parent": {
|
| 197 |
+
"description": "Required. The endpoint's parent.",
|
| 198 |
+
"location": "path",
|
| 199 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 200 |
+
"required": true,
|
| 201 |
+
"type": "string"
|
| 202 |
+
},
|
| 203 |
+
"requestId": {
|
| 204 |
+
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
|
| 205 |
+
"location": "query",
|
| 206 |
+
"type": "string"
|
| 207 |
+
}
|
| 208 |
+
},
|
| 209 |
+
"path": "v1/{+parent}/endpoints",
|
| 210 |
+
"request": {
|
| 211 |
+
"$ref": "Endpoint"
|
| 212 |
+
},
|
| 213 |
+
"response": {
|
| 214 |
+
"$ref": "Operation"
|
| 215 |
+
},
|
| 216 |
+
"scopes": [
|
| 217 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 218 |
+
]
|
| 219 |
+
},
|
| 220 |
+
"delete": {
|
| 221 |
+
"description": "Deletes a single Endpoint.",
|
| 222 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
|
| 223 |
+
"httpMethod": "DELETE",
|
| 224 |
+
"id": "ids.projects.locations.endpoints.delete",
|
| 225 |
+
"parameterOrder": [
|
| 226 |
+
"name"
|
| 227 |
+
],
|
| 228 |
+
"parameters": {
|
| 229 |
+
"name": {
|
| 230 |
+
"description": "Required. The name of the endpoint to delete.",
|
| 231 |
+
"location": "path",
|
| 232 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 233 |
+
"required": true,
|
| 234 |
+
"type": "string"
|
| 235 |
+
},
|
| 236 |
+
"requestId": {
|
| 237 |
+
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
|
| 238 |
+
"location": "query",
|
| 239 |
+
"type": "string"
|
| 240 |
+
}
|
| 241 |
+
},
|
| 242 |
+
"path": "v1/{+name}",
|
| 243 |
+
"response": {
|
| 244 |
+
"$ref": "Operation"
|
| 245 |
+
},
|
| 246 |
+
"scopes": [
|
| 247 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 248 |
+
]
|
| 249 |
+
},
|
| 250 |
+
"get": {
|
| 251 |
+
"description": "Gets details of a single Endpoint.",
|
| 252 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
|
| 253 |
+
"httpMethod": "GET",
|
| 254 |
+
"id": "ids.projects.locations.endpoints.get",
|
| 255 |
+
"parameterOrder": [
|
| 256 |
+
"name"
|
| 257 |
+
],
|
| 258 |
+
"parameters": {
|
| 259 |
+
"name": {
|
| 260 |
+
"description": "Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}",
|
| 261 |
+
"location": "path",
|
| 262 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 263 |
+
"required": true,
|
| 264 |
+
"type": "string"
|
| 265 |
+
}
|
| 266 |
+
},
|
| 267 |
+
"path": "v1/{+name}",
|
| 268 |
+
"response": {
|
| 269 |
+
"$ref": "Endpoint"
|
| 270 |
+
},
|
| 271 |
+
"scopes": [
|
| 272 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 273 |
+
]
|
| 274 |
+
},
|
| 275 |
+
"getIamPolicy": {
|
| 276 |
+
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
|
| 277 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy",
|
| 278 |
+
"httpMethod": "GET",
|
| 279 |
+
"id": "ids.projects.locations.endpoints.getIamPolicy",
|
| 280 |
+
"parameterOrder": [
|
| 281 |
+
"resource"
|
| 282 |
+
],
|
| 283 |
+
"parameters": {
|
| 284 |
+
"options.requestedPolicyVersion": {
|
| 285 |
+
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 286 |
+
"format": "int32",
|
| 287 |
+
"location": "query",
|
| 288 |
+
"type": "integer"
|
| 289 |
+
},
|
| 290 |
+
"resource": {
|
| 291 |
+
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 292 |
+
"location": "path",
|
| 293 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 294 |
+
"required": true,
|
| 295 |
+
"type": "string"
|
| 296 |
+
}
|
| 297 |
+
},
|
| 298 |
+
"path": "v1/{+resource}:getIamPolicy",
|
| 299 |
+
"response": {
|
| 300 |
+
"$ref": "Policy"
|
| 301 |
+
},
|
| 302 |
+
"scopes": [
|
| 303 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 304 |
+
]
|
| 305 |
+
},
|
| 306 |
+
"list": {
|
| 307 |
+
"description": "Lists Endpoints in a given project and location.",
|
| 308 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
|
| 309 |
+
"httpMethod": "GET",
|
| 310 |
+
"id": "ids.projects.locations.endpoints.list",
|
| 311 |
+
"parameterOrder": [
|
| 312 |
+
"parent"
|
| 313 |
+
],
|
| 314 |
+
"parameters": {
|
| 315 |
+
"filter": {
|
| 316 |
+
"description": "Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.",
|
| 317 |
+
"location": "query",
|
| 318 |
+
"type": "string"
|
| 319 |
+
},
|
| 320 |
+
"orderBy": {
|
| 321 |
+
"description": "Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.",
|
| 322 |
+
"location": "query",
|
| 323 |
+
"type": "string"
|
| 324 |
+
},
|
| 325 |
+
"pageSize": {
|
| 326 |
+
"description": "Optional. The maximum number of endpoints to return. The service may return fewer than this value.",
|
| 327 |
+
"format": "int32",
|
| 328 |
+
"location": "query",
|
| 329 |
+
"type": "integer"
|
| 330 |
+
},
|
| 331 |
+
"pageToken": {
|
| 332 |
+
"description": "Optional. A page token, received from a previous `ListEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEndpoints` must match the call that provided the page token.",
|
| 333 |
+
"location": "query",
|
| 334 |
+
"type": "string"
|
| 335 |
+
},
|
| 336 |
+
"parent": {
|
| 337 |
+
"description": "Required. The parent, which owns this collection of endpoints.",
|
| 338 |
+
"location": "path",
|
| 339 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 340 |
+
"required": true,
|
| 341 |
+
"type": "string"
|
| 342 |
+
}
|
| 343 |
+
},
|
| 344 |
+
"path": "v1/{+parent}/endpoints",
|
| 345 |
+
"response": {
|
| 346 |
+
"$ref": "ListEndpointsResponse"
|
| 347 |
+
},
|
| 348 |
+
"scopes": [
|
| 349 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 350 |
+
]
|
| 351 |
+
},
|
| 352 |
+
"patch": {
|
| 353 |
+
"description": "Updates the parameters of a single Endpoint.",
|
| 354 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
|
| 355 |
+
"httpMethod": "PATCH",
|
| 356 |
+
"id": "ids.projects.locations.endpoints.patch",
|
| 357 |
+
"parameterOrder": [
|
| 358 |
+
"name"
|
| 359 |
+
],
|
| 360 |
+
"parameters": {
|
| 361 |
+
"name": {
|
| 362 |
+
"description": "Output only. The name of the endpoint.",
|
| 363 |
+
"location": "path",
|
| 364 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 365 |
+
"required": true,
|
| 366 |
+
"type": "string"
|
| 367 |
+
},
|
| 368 |
+
"requestId": {
|
| 369 |
+
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
|
| 370 |
+
"location": "query",
|
| 371 |
+
"type": "string"
|
| 372 |
+
},
|
| 373 |
+
"updateMask": {
|
| 374 |
+
"description": "Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
|
| 375 |
+
"format": "google-fieldmask",
|
| 376 |
+
"location": "query",
|
| 377 |
+
"type": "string"
|
| 378 |
+
}
|
| 379 |
+
},
|
| 380 |
+
"path": "v1/{+name}",
|
| 381 |
+
"request": {
|
| 382 |
+
"$ref": "Endpoint"
|
| 383 |
+
},
|
| 384 |
+
"response": {
|
| 385 |
+
"$ref": "Operation"
|
| 386 |
+
},
|
| 387 |
+
"scopes": [
|
| 388 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 389 |
+
]
|
| 390 |
+
},
|
| 391 |
+
"setIamPolicy": {
|
| 392 |
+
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
|
| 393 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy",
|
| 394 |
+
"httpMethod": "POST",
|
| 395 |
+
"id": "ids.projects.locations.endpoints.setIamPolicy",
|
| 396 |
+
"parameterOrder": [
|
| 397 |
+
"resource"
|
| 398 |
+
],
|
| 399 |
+
"parameters": {
|
| 400 |
+
"resource": {
|
| 401 |
+
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 402 |
+
"location": "path",
|
| 403 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 404 |
+
"required": true,
|
| 405 |
+
"type": "string"
|
| 406 |
+
}
|
| 407 |
+
},
|
| 408 |
+
"path": "v1/{+resource}:setIamPolicy",
|
| 409 |
+
"request": {
|
| 410 |
+
"$ref": "SetIamPolicyRequest"
|
| 411 |
+
},
|
| 412 |
+
"response": {
|
| 413 |
+
"$ref": "Policy"
|
| 414 |
+
},
|
| 415 |
+
"scopes": [
|
| 416 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 417 |
+
]
|
| 418 |
+
},
|
| 419 |
+
"testIamPermissions": {
|
| 420 |
+
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.",
|
| 421 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions",
|
| 422 |
+
"httpMethod": "POST",
|
| 423 |
+
"id": "ids.projects.locations.endpoints.testIamPermissions",
|
| 424 |
+
"parameterOrder": [
|
| 425 |
+
"resource"
|
| 426 |
+
],
|
| 427 |
+
"parameters": {
|
| 428 |
+
"resource": {
|
| 429 |
+
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
|
| 430 |
+
"location": "path",
|
| 431 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
|
| 432 |
+
"required": true,
|
| 433 |
+
"type": "string"
|
| 434 |
+
}
|
| 435 |
+
},
|
| 436 |
+
"path": "v1/{+resource}:testIamPermissions",
|
| 437 |
+
"request": {
|
| 438 |
+
"$ref": "TestIamPermissionsRequest"
|
| 439 |
+
},
|
| 440 |
+
"response": {
|
| 441 |
+
"$ref": "TestIamPermissionsResponse"
|
| 442 |
+
},
|
| 443 |
+
"scopes": [
|
| 444 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 445 |
+
]
|
| 446 |
+
}
|
| 447 |
+
}
|
| 448 |
+
},
|
| 449 |
+
"operations": {
|
| 450 |
+
"methods": {
|
| 451 |
+
"cancel": {
|
| 452 |
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 453 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
|
| 454 |
+
"httpMethod": "POST",
|
| 455 |
+
"id": "ids.projects.locations.operations.cancel",
|
| 456 |
+
"parameterOrder": [
|
| 457 |
+
"name"
|
| 458 |
+
],
|
| 459 |
+
"parameters": {
|
| 460 |
+
"name": {
|
| 461 |
+
"description": "The name of the operation resource to be cancelled.",
|
| 462 |
+
"location": "path",
|
| 463 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 464 |
+
"required": true,
|
| 465 |
+
"type": "string"
|
| 466 |
+
}
|
| 467 |
+
},
|
| 468 |
+
"path": "v1/{+name}:cancel",
|
| 469 |
+
"request": {
|
| 470 |
+
"$ref": "CancelOperationRequest"
|
| 471 |
+
},
|
| 472 |
+
"response": {
|
| 473 |
+
"$ref": "Empty"
|
| 474 |
+
},
|
| 475 |
+
"scopes": [
|
| 476 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 477 |
+
]
|
| 478 |
+
},
|
| 479 |
+
"delete": {
|
| 480 |
+
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
|
| 481 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
| 482 |
+
"httpMethod": "DELETE",
|
| 483 |
+
"id": "ids.projects.locations.operations.delete",
|
| 484 |
+
"parameterOrder": [
|
| 485 |
+
"name"
|
| 486 |
+
],
|
| 487 |
+
"parameters": {
|
| 488 |
+
"name": {
|
| 489 |
+
"description": "The name of the operation resource to be deleted.",
|
| 490 |
+
"location": "path",
|
| 491 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 492 |
+
"required": true,
|
| 493 |
+
"type": "string"
|
| 494 |
+
}
|
| 495 |
+
},
|
| 496 |
+
"path": "v1/{+name}",
|
| 497 |
+
"response": {
|
| 498 |
+
"$ref": "Empty"
|
| 499 |
+
},
|
| 500 |
+
"scopes": [
|
| 501 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 502 |
+
]
|
| 503 |
+
},
|
| 504 |
+
"get": {
|
| 505 |
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
| 506 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
| 507 |
+
"httpMethod": "GET",
|
| 508 |
+
"id": "ids.projects.locations.operations.get",
|
| 509 |
+
"parameterOrder": [
|
| 510 |
+
"name"
|
| 511 |
+
],
|
| 512 |
+
"parameters": {
|
| 513 |
+
"name": {
|
| 514 |
+
"description": "The name of the operation resource.",
|
| 515 |
+
"location": "path",
|
| 516 |
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
| 517 |
+
"required": true,
|
| 518 |
+
"type": "string"
|
| 519 |
+
}
|
| 520 |
+
},
|
| 521 |
+
"path": "v1/{+name}",
|
| 522 |
+
"response": {
|
| 523 |
+
"$ref": "Operation"
|
| 524 |
+
},
|
| 525 |
+
"scopes": [
|
| 526 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 527 |
+
]
|
| 528 |
+
},
|
| 529 |
+
"list": {
|
| 530 |
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
| 531 |
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
|
| 532 |
+
"httpMethod": "GET",
|
| 533 |
+
"id": "ids.projects.locations.operations.list",
|
| 534 |
+
"parameterOrder": [
|
| 535 |
+
"name"
|
| 536 |
+
],
|
| 537 |
+
"parameters": {
|
| 538 |
+
"filter": {
|
| 539 |
+
"description": "The standard list filter.",
|
| 540 |
+
"location": "query",
|
| 541 |
+
"type": "string"
|
| 542 |
+
},
|
| 543 |
+
"name": {
|
| 544 |
+
"description": "The name of the operation's parent resource.",
|
| 545 |
+
"location": "path",
|
| 546 |
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
| 547 |
+
"required": true,
|
| 548 |
+
"type": "string"
|
| 549 |
+
},
|
| 550 |
+
"pageSize": {
|
| 551 |
+
"description": "The standard list page size.",
|
| 552 |
+
"format": "int32",
|
| 553 |
+
"location": "query",
|
| 554 |
+
"type": "integer"
|
| 555 |
+
},
|
| 556 |
+
"pageToken": {
|
| 557 |
+
"description": "The standard list page token.",
|
| 558 |
+
"location": "query",
|
| 559 |
+
"type": "string"
|
| 560 |
+
}
|
| 561 |
+
},
|
| 562 |
+
"path": "v1/{+name}/operations",
|
| 563 |
+
"response": {
|
| 564 |
+
"$ref": "ListOperationsResponse"
|
| 565 |
+
},
|
| 566 |
+
"scopes": [
|
| 567 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 568 |
+
]
|
| 569 |
+
}
|
| 570 |
+
}
|
| 571 |
+
}
|
| 572 |
+
}
|
| 573 |
+
}
|
| 574 |
+
}
|
| 575 |
+
}
|
| 576 |
+
},
|
| 577 |
+
"revision": "20240627",
|
| 578 |
+
"rootUrl": "https://ids.googleapis.com/",
|
| 579 |
+
"schemas": {
|
| 580 |
+
"AuditConfig": {
|
| 581 |
+
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
|
| 582 |
+
"id": "AuditConfig",
|
| 583 |
+
"properties": {
|
| 584 |
+
"auditLogConfigs": {
|
| 585 |
+
"description": "The configuration for logging of each type of permission.",
|
| 586 |
+
"items": {
|
| 587 |
+
"$ref": "AuditLogConfig"
|
| 588 |
+
},
|
| 589 |
+
"type": "array"
|
| 590 |
+
},
|
| 591 |
+
"service": {
|
| 592 |
+
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
|
| 593 |
+
"type": "string"
|
| 594 |
+
}
|
| 595 |
+
},
|
| 596 |
+
"type": "object"
|
| 597 |
+
},
|
| 598 |
+
"AuditLogConfig": {
|
| 599 |
+
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
|
| 600 |
+
"id": "AuditLogConfig",
|
| 601 |
+
"properties": {
|
| 602 |
+
"exemptedMembers": {
|
| 603 |
+
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
|
| 604 |
+
"items": {
|
| 605 |
+
"type": "string"
|
| 606 |
+
},
|
| 607 |
+
"type": "array"
|
| 608 |
+
},
|
| 609 |
+
"logType": {
|
| 610 |
+
"description": "The log type that this config enables.",
|
| 611 |
+
"enum": [
|
| 612 |
+
"LOG_TYPE_UNSPECIFIED",
|
| 613 |
+
"ADMIN_READ",
|
| 614 |
+
"DATA_WRITE",
|
| 615 |
+
"DATA_READ"
|
| 616 |
+
],
|
| 617 |
+
"enumDescriptions": [
|
| 618 |
+
"Default case. Should never be this.",
|
| 619 |
+
"Admin reads. Example: CloudIAM getIamPolicy",
|
| 620 |
+
"Data writes. Example: CloudSQL Users create",
|
| 621 |
+
"Data reads. Example: CloudSQL Users list"
|
| 622 |
+
],
|
| 623 |
+
"type": "string"
|
| 624 |
+
}
|
| 625 |
+
},
|
| 626 |
+
"type": "object"
|
| 627 |
+
},
|
| 628 |
+
"Binding": {
|
| 629 |
+
"description": "Associates `members`, or principals, with a `role`.",
|
| 630 |
+
"id": "Binding",
|
| 631 |
+
"properties": {
|
| 632 |
+
"condition": {
|
| 633 |
+
"$ref": "Expr",
|
| 634 |
+
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
|
| 635 |
+
},
|
| 636 |
+
"members": {
|
| 637 |
+
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
|
| 638 |
+
"items": {
|
| 639 |
+
"type": "string"
|
| 640 |
+
},
|
| 641 |
+
"type": "array"
|
| 642 |
+
},
|
| 643 |
+
"role": {
|
| 644 |
+
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
|
| 645 |
+
"type": "string"
|
| 646 |
+
}
|
| 647 |
+
},
|
| 648 |
+
"type": "object"
|
| 649 |
+
},
|
| 650 |
+
"CancelOperationRequest": {
|
| 651 |
+
"description": "The request message for Operations.CancelOperation.",
|
| 652 |
+
"id": "CancelOperationRequest",
|
| 653 |
+
"properties": {},
|
| 654 |
+
"type": "object"
|
| 655 |
+
},
|
| 656 |
+
"Empty": {
|
| 657 |
+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
| 658 |
+
"id": "Empty",
|
| 659 |
+
"properties": {},
|
| 660 |
+
"type": "object"
|
| 661 |
+
},
|
| 662 |
+
"Endpoint": {
|
| 663 |
+
"description": "Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.",
|
| 664 |
+
"id": "Endpoint",
|
| 665 |
+
"properties": {
|
| 666 |
+
"createTime": {
|
| 667 |
+
"description": "Output only. The create time timestamp.",
|
| 668 |
+
"format": "google-datetime",
|
| 669 |
+
"readOnly": true,
|
| 670 |
+
"type": "string"
|
| 671 |
+
},
|
| 672 |
+
"description": {
|
| 673 |
+
"description": "User-provided description of the endpoint",
|
| 674 |
+
"type": "string"
|
| 675 |
+
},
|
| 676 |
+
"endpointForwardingRule": {
|
| 677 |
+
"description": "Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.",
|
| 678 |
+
"readOnly": true,
|
| 679 |
+
"type": "string"
|
| 680 |
+
},
|
| 681 |
+
"endpointIp": {
|
| 682 |
+
"description": "Output only. The IP address of the IDS Endpoint's ILB.",
|
| 683 |
+
"readOnly": true,
|
| 684 |
+
"type": "string"
|
| 685 |
+
},
|
| 686 |
+
"labels": {
|
| 687 |
+
"additionalProperties": {
|
| 688 |
+
"type": "string"
|
| 689 |
+
},
|
| 690 |
+
"description": "The labels of the endpoint.",
|
| 691 |
+
"type": "object"
|
| 692 |
+
},
|
| 693 |
+
"name": {
|
| 694 |
+
"description": "Output only. The name of the endpoint.",
|
| 695 |
+
"readOnly": true,
|
| 696 |
+
"type": "string"
|
| 697 |
+
},
|
| 698 |
+
"network": {
|
| 699 |
+
"description": "Required. The fully qualified URL of the network to which the IDS Endpoint is attached.",
|
| 700 |
+
"type": "string"
|
| 701 |
+
},
|
| 702 |
+
"satisfiesPzi": {
|
| 703 |
+
"description": "Output only. [Output Only] Reserved for future use.",
|
| 704 |
+
"readOnly": true,
|
| 705 |
+
"type": "boolean"
|
| 706 |
+
},
|
| 707 |
+
"satisfiesPzs": {
|
| 708 |
+
"description": "Output only. [Output Only] Reserved for future use.",
|
| 709 |
+
"readOnly": true,
|
| 710 |
+
"type": "boolean"
|
| 711 |
+
},
|
| 712 |
+
"severity": {
|
| 713 |
+
"description": "Required. Lowest threat severity that this endpoint will alert on.",
|
| 714 |
+
"enum": [
|
| 715 |
+
"SEVERITY_UNSPECIFIED",
|
| 716 |
+
"INFORMATIONAL",
|
| 717 |
+
"LOW",
|
| 718 |
+
"MEDIUM",
|
| 719 |
+
"HIGH",
|
| 720 |
+
"CRITICAL"
|
| 721 |
+
],
|
| 722 |
+
"enumDescriptions": [
|
| 723 |
+
"Not set.",
|
| 724 |
+
"Informational alerts.",
|
| 725 |
+
"Low severity alerts.",
|
| 726 |
+
"Medium severity alerts.",
|
| 727 |
+
"High severity alerts.",
|
| 728 |
+
"Critical severity alerts."
|
| 729 |
+
],
|
| 730 |
+
"type": "string"
|
| 731 |
+
},
|
| 732 |
+
"state": {
|
| 733 |
+
"description": "Output only. Current state of the endpoint.",
|
| 734 |
+
"enum": [
|
| 735 |
+
"STATE_UNSPECIFIED",
|
| 736 |
+
"CREATING",
|
| 737 |
+
"READY",
|
| 738 |
+
"DELETING",
|
| 739 |
+
"UPDATING"
|
| 740 |
+
],
|
| 741 |
+
"enumDescriptions": [
|
| 742 |
+
"Not set.",
|
| 743 |
+
"Being created.",
|
| 744 |
+
"Active and ready for traffic.",
|
| 745 |
+
"Being deleted.",
|
| 746 |
+
"Being updated."
|
| 747 |
+
],
|
| 748 |
+
"readOnly": true,
|
| 749 |
+
"type": "string"
|
| 750 |
+
},
|
| 751 |
+
"threatExceptions": {
|
| 752 |
+
"description": "List of threat IDs to be excepted from generating alerts.",
|
| 753 |
+
"items": {
|
| 754 |
+
"type": "string"
|
| 755 |
+
},
|
| 756 |
+
"type": "array"
|
| 757 |
+
},
|
| 758 |
+
"trafficLogs": {
|
| 759 |
+
"description": "Whether the endpoint should report traffic logs in addition to threat logs.",
|
| 760 |
+
"type": "boolean"
|
| 761 |
+
},
|
| 762 |
+
"updateTime": {
|
| 763 |
+
"description": "Output only. The update time timestamp.",
|
| 764 |
+
"format": "google-datetime",
|
| 765 |
+
"readOnly": true,
|
| 766 |
+
"type": "string"
|
| 767 |
+
}
|
| 768 |
+
},
|
| 769 |
+
"type": "object"
|
| 770 |
+
},
|
| 771 |
+
"Expr": {
|
| 772 |
+
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
|
| 773 |
+
"id": "Expr",
|
| 774 |
+
"properties": {
|
| 775 |
+
"description": {
|
| 776 |
+
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
|
| 777 |
+
"type": "string"
|
| 778 |
+
},
|
| 779 |
+
"expression": {
|
| 780 |
+
"description": "Textual representation of an expression in Common Expression Language syntax.",
|
| 781 |
+
"type": "string"
|
| 782 |
+
},
|
| 783 |
+
"location": {
|
| 784 |
+
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
|
| 785 |
+
"type": "string"
|
| 786 |
+
},
|
| 787 |
+
"title": {
|
| 788 |
+
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
|
| 789 |
+
"type": "string"
|
| 790 |
+
}
|
| 791 |
+
},
|
| 792 |
+
"type": "object"
|
| 793 |
+
},
|
| 794 |
+
"ListEndpointsResponse": {
|
| 795 |
+
"id": "ListEndpointsResponse",
|
| 796 |
+
"properties": {
|
| 797 |
+
"endpoints": {
|
| 798 |
+
"description": "The list of endpoints response.",
|
| 799 |
+
"items": {
|
| 800 |
+
"$ref": "Endpoint"
|
| 801 |
+
},
|
| 802 |
+
"type": "array"
|
| 803 |
+
},
|
| 804 |
+
"nextPageToken": {
|
| 805 |
+
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
| 806 |
+
"type": "string"
|
| 807 |
+
},
|
| 808 |
+
"unreachable": {
|
| 809 |
+
"description": "Locations that could not be reached.",
|
| 810 |
+
"items": {
|
| 811 |
+
"type": "string"
|
| 812 |
+
},
|
| 813 |
+
"type": "array"
|
| 814 |
+
}
|
| 815 |
+
},
|
| 816 |
+
"type": "object"
|
| 817 |
+
},
|
| 818 |
+
"ListLocationsResponse": {
|
| 819 |
+
"description": "The response message for Locations.ListLocations.",
|
| 820 |
+
"id": "ListLocationsResponse",
|
| 821 |
+
"properties": {
|
| 822 |
+
"locations": {
|
| 823 |
+
"description": "A list of locations that matches the specified filter in the request.",
|
| 824 |
+
"items": {
|
| 825 |
+
"$ref": "Location"
|
| 826 |
+
},
|
| 827 |
+
"type": "array"
|
| 828 |
+
},
|
| 829 |
+
"nextPageToken": {
|
| 830 |
+
"description": "The standard List next-page token.",
|
| 831 |
+
"type": "string"
|
| 832 |
+
}
|
| 833 |
+
},
|
| 834 |
+
"type": "object"
|
| 835 |
+
},
|
| 836 |
+
"ListOperationsResponse": {
|
| 837 |
+
"description": "The response message for Operations.ListOperations.",
|
| 838 |
+
"id": "ListOperationsResponse",
|
| 839 |
+
"properties": {
|
| 840 |
+
"nextPageToken": {
|
| 841 |
+
"description": "The standard List next-page token.",
|
| 842 |
+
"type": "string"
|
| 843 |
+
},
|
| 844 |
+
"operations": {
|
| 845 |
+
"description": "A list of operations that matches the specified filter in the request.",
|
| 846 |
+
"items": {
|
| 847 |
+
"$ref": "Operation"
|
| 848 |
+
},
|
| 849 |
+
"type": "array"
|
| 850 |
+
}
|
| 851 |
+
},
|
| 852 |
+
"type": "object"
|
| 853 |
+
},
|
| 854 |
+
"Location": {
|
| 855 |
+
"description": "A resource that represents a Google Cloud location.",
|
| 856 |
+
"id": "Location",
|
| 857 |
+
"properties": {
|
| 858 |
+
"displayName": {
|
| 859 |
+
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
|
| 860 |
+
"type": "string"
|
| 861 |
+
},
|
| 862 |
+
"labels": {
|
| 863 |
+
"additionalProperties": {
|
| 864 |
+
"type": "string"
|
| 865 |
+
},
|
| 866 |
+
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
|
| 867 |
+
"type": "object"
|
| 868 |
+
},
|
| 869 |
+
"locationId": {
|
| 870 |
+
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
|
| 871 |
+
"type": "string"
|
| 872 |
+
},
|
| 873 |
+
"metadata": {
|
| 874 |
+
"additionalProperties": {
|
| 875 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 876 |
+
"type": "any"
|
| 877 |
+
},
|
| 878 |
+
"description": "Service-specific metadata. For example the available capacity at the given location.",
|
| 879 |
+
"type": "object"
|
| 880 |
+
},
|
| 881 |
+
"name": {
|
| 882 |
+
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
|
| 883 |
+
"type": "string"
|
| 884 |
+
}
|
| 885 |
+
},
|
| 886 |
+
"type": "object"
|
| 887 |
+
},
|
| 888 |
+
"Operation": {
|
| 889 |
+
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
| 890 |
+
"id": "Operation",
|
| 891 |
+
"properties": {
|
| 892 |
+
"done": {
|
| 893 |
+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
|
| 894 |
+
"type": "boolean"
|
| 895 |
+
},
|
| 896 |
+
"error": {
|
| 897 |
+
"$ref": "Status",
|
| 898 |
+
"description": "The error result of the operation in case of failure or cancellation."
|
| 899 |
+
},
|
| 900 |
+
"metadata": {
|
| 901 |
+
"additionalProperties": {
|
| 902 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 903 |
+
"type": "any"
|
| 904 |
+
},
|
| 905 |
+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
| 906 |
+
"type": "object"
|
| 907 |
+
},
|
| 908 |
+
"name": {
|
| 909 |
+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
|
| 910 |
+
"type": "string"
|
| 911 |
+
},
|
| 912 |
+
"response": {
|
| 913 |
+
"additionalProperties": {
|
| 914 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 915 |
+
"type": "any"
|
| 916 |
+
},
|
| 917 |
+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
| 918 |
+
"type": "object"
|
| 919 |
+
}
|
| 920 |
+
},
|
| 921 |
+
"type": "object"
|
| 922 |
+
},
|
| 923 |
+
"OperationMetadata": {
|
| 924 |
+
"description": "Represents the metadata of the long-running operation.",
|
| 925 |
+
"id": "OperationMetadata",
|
| 926 |
+
"properties": {
|
| 927 |
+
"apiVersion": {
|
| 928 |
+
"description": "Output only. API version used to start the operation.",
|
| 929 |
+
"readOnly": true,
|
| 930 |
+
"type": "string"
|
| 931 |
+
},
|
| 932 |
+
"createTime": {
|
| 933 |
+
"description": "Output only. The time the operation was created.",
|
| 934 |
+
"format": "google-datetime",
|
| 935 |
+
"readOnly": true,
|
| 936 |
+
"type": "string"
|
| 937 |
+
},
|
| 938 |
+
"endTime": {
|
| 939 |
+
"description": "Output only. The time the operation finished running.",
|
| 940 |
+
"format": "google-datetime",
|
| 941 |
+
"readOnly": true,
|
| 942 |
+
"type": "string"
|
| 943 |
+
},
|
| 944 |
+
"requestedCancellation": {
|
| 945 |
+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
|
| 946 |
+
"readOnly": true,
|
| 947 |
+
"type": "boolean"
|
| 948 |
+
},
|
| 949 |
+
"statusMessage": {
|
| 950 |
+
"description": "Output only. Human-readable status of the operation, if any.",
|
| 951 |
+
"readOnly": true,
|
| 952 |
+
"type": "string"
|
| 953 |
+
},
|
| 954 |
+
"target": {
|
| 955 |
+
"description": "Output only. Server-defined resource path for the target of the operation.",
|
| 956 |
+
"readOnly": true,
|
| 957 |
+
"type": "string"
|
| 958 |
+
},
|
| 959 |
+
"verb": {
|
| 960 |
+
"description": "Output only. Name of the verb executed by the operation.",
|
| 961 |
+
"readOnly": true,
|
| 962 |
+
"type": "string"
|
| 963 |
+
}
|
| 964 |
+
},
|
| 965 |
+
"type": "object"
|
| 966 |
+
},
|
| 967 |
+
"Policy": {
|
| 968 |
+
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **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')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **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') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
|
| 969 |
+
"id": "Policy",
|
| 970 |
+
"properties": {
|
| 971 |
+
"auditConfigs": {
|
| 972 |
+
"description": "Specifies cloud audit logging configuration for this policy.",
|
| 973 |
+
"items": {
|
| 974 |
+
"$ref": "AuditConfig"
|
| 975 |
+
},
|
| 976 |
+
"type": "array"
|
| 977 |
+
},
|
| 978 |
+
"bindings": {
|
| 979 |
+
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
|
| 980 |
+
"items": {
|
| 981 |
+
"$ref": "Binding"
|
| 982 |
+
},
|
| 983 |
+
"type": "array"
|
| 984 |
+
},
|
| 985 |
+
"etag": {
|
| 986 |
+
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
|
| 987 |
+
"format": "byte",
|
| 988 |
+
"type": "string"
|
| 989 |
+
},
|
| 990 |
+
"version": {
|
| 991 |
+
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
|
| 992 |
+
"format": "int32",
|
| 993 |
+
"type": "integer"
|
| 994 |
+
}
|
| 995 |
+
},
|
| 996 |
+
"type": "object"
|
| 997 |
+
},
|
| 998 |
+
"SetIamPolicyRequest": {
|
| 999 |
+
"description": "Request message for `SetIamPolicy` method.",
|
| 1000 |
+
"id": "SetIamPolicyRequest",
|
| 1001 |
+
"properties": {
|
| 1002 |
+
"policy": {
|
| 1003 |
+
"$ref": "Policy",
|
| 1004 |
+
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
|
| 1005 |
+
},
|
| 1006 |
+
"updateMask": {
|
| 1007 |
+
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
|
| 1008 |
+
"format": "google-fieldmask",
|
| 1009 |
+
"type": "string"
|
| 1010 |
+
}
|
| 1011 |
+
},
|
| 1012 |
+
"type": "object"
|
| 1013 |
+
},
|
| 1014 |
+
"Status": {
|
| 1015 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 1016 |
+
"id": "Status",
|
| 1017 |
+
"properties": {
|
| 1018 |
+
"code": {
|
| 1019 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 1020 |
+
"format": "int32",
|
| 1021 |
+
"type": "integer"
|
| 1022 |
+
},
|
| 1023 |
+
"details": {
|
| 1024 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 1025 |
+
"items": {
|
| 1026 |
+
"additionalProperties": {
|
| 1027 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1028 |
+
"type": "any"
|
| 1029 |
+
},
|
| 1030 |
+
"type": "object"
|
| 1031 |
+
},
|
| 1032 |
+
"type": "array"
|
| 1033 |
+
},
|
| 1034 |
+
"message": {
|
| 1035 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 1036 |
+
"type": "string"
|
| 1037 |
+
}
|
| 1038 |
+
},
|
| 1039 |
+
"type": "object"
|
| 1040 |
+
},
|
| 1041 |
+
"TestIamPermissionsRequest": {
|
| 1042 |
+
"description": "Request message for `TestIamPermissions` method.",
|
| 1043 |
+
"id": "TestIamPermissionsRequest",
|
| 1044 |
+
"properties": {
|
| 1045 |
+
"permissions": {
|
| 1046 |
+
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| 1047 |
+
"items": {
|
| 1048 |
+
"type": "string"
|
| 1049 |
+
},
|
| 1050 |
+
"type": "array"
|
| 1051 |
+
}
|
| 1052 |
+
},
|
| 1053 |
+
"type": "object"
|
| 1054 |
+
},
|
| 1055 |
+
"TestIamPermissionsResponse": {
|
| 1056 |
+
"description": "Response message for `TestIamPermissions` method.",
|
| 1057 |
+
"id": "TestIamPermissionsResponse",
|
| 1058 |
+
"properties": {
|
| 1059 |
+
"permissions": {
|
| 1060 |
+
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
|
| 1061 |
+
"items": {
|
| 1062 |
+
"type": "string"
|
| 1063 |
+
},
|
| 1064 |
+
"type": "array"
|
| 1065 |
+
}
|
| 1066 |
+
},
|
| 1067 |
+
"type": "object"
|
| 1068 |
+
}
|
| 1069 |
+
},
|
| 1070 |
+
"servicePath": "",
|
| 1071 |
+
"title": "Cloud IDS API",
|
| 1072 |
+
"version": "v1",
|
| 1073 |
+
"version_module": true
|
| 1074 |
+
}
|
.venv/lib/python3.11/site-packages/googleapiclient/discovery_cache/documents/language.v1beta1.json
ADDED
|
@@ -0,0 +1,1100 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"auth": {
|
| 3 |
+
"oauth2": {
|
| 4 |
+
"scopes": {
|
| 5 |
+
"https://www.googleapis.com/auth/cloud-language": {
|
| 6 |
+
"description": "Apply machine learning models to reveal the structure and meaning of text"
|
| 7 |
+
},
|
| 8 |
+
"https://www.googleapis.com/auth/cloud-platform": {
|
| 9 |
+
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
}
|
| 13 |
+
},
|
| 14 |
+
"basePath": "",
|
| 15 |
+
"baseUrl": "https://language.googleapis.com/",
|
| 16 |
+
"batchPath": "batch",
|
| 17 |
+
"canonicalName": "Cloud Natural Language",
|
| 18 |
+
"description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.",
|
| 19 |
+
"discoveryVersion": "v1",
|
| 20 |
+
"documentationLink": "https://cloud.google.com/natural-language/",
|
| 21 |
+
"fullyEncodeReservedExpansion": true,
|
| 22 |
+
"icons": {
|
| 23 |
+
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| 24 |
+
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| 25 |
+
},
|
| 26 |
+
"id": "language:v1beta1",
|
| 27 |
+
"kind": "discovery#restDescription",
|
| 28 |
+
"mtlsRootUrl": "https://language.mtls.googleapis.com/",
|
| 29 |
+
"name": "language",
|
| 30 |
+
"ownerDomain": "google.com",
|
| 31 |
+
"ownerName": "Google",
|
| 32 |
+
"parameters": {
|
| 33 |
+
"$.xgafv": {
|
| 34 |
+
"description": "V1 error format.",
|
| 35 |
+
"enum": [
|
| 36 |
+
"1",
|
| 37 |
+
"2"
|
| 38 |
+
],
|
| 39 |
+
"enumDescriptions": [
|
| 40 |
+
"v1 error format",
|
| 41 |
+
"v2 error format"
|
| 42 |
+
],
|
| 43 |
+
"location": "query",
|
| 44 |
+
"type": "string"
|
| 45 |
+
},
|
| 46 |
+
"access_token": {
|
| 47 |
+
"description": "OAuth access token.",
|
| 48 |
+
"location": "query",
|
| 49 |
+
"type": "string"
|
| 50 |
+
},
|
| 51 |
+
"alt": {
|
| 52 |
+
"default": "json",
|
| 53 |
+
"description": "Data format for response.",
|
| 54 |
+
"enum": [
|
| 55 |
+
"json",
|
| 56 |
+
"media",
|
| 57 |
+
"proto"
|
| 58 |
+
],
|
| 59 |
+
"enumDescriptions": [
|
| 60 |
+
"Responses with Content-Type of application/json",
|
| 61 |
+
"Media download with context-dependent Content-Type",
|
| 62 |
+
"Responses with Content-Type of application/x-protobuf"
|
| 63 |
+
],
|
| 64 |
+
"location": "query",
|
| 65 |
+
"type": "string"
|
| 66 |
+
},
|
| 67 |
+
"callback": {
|
| 68 |
+
"description": "JSONP",
|
| 69 |
+
"location": "query",
|
| 70 |
+
"type": "string"
|
| 71 |
+
},
|
| 72 |
+
"fields": {
|
| 73 |
+
"description": "Selector specifying which fields to include in a partial response.",
|
| 74 |
+
"location": "query",
|
| 75 |
+
"type": "string"
|
| 76 |
+
},
|
| 77 |
+
"key": {
|
| 78 |
+
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| 79 |
+
"location": "query",
|
| 80 |
+
"type": "string"
|
| 81 |
+
},
|
| 82 |
+
"oauth_token": {
|
| 83 |
+
"description": "OAuth 2.0 token for the current user.",
|
| 84 |
+
"location": "query",
|
| 85 |
+
"type": "string"
|
| 86 |
+
},
|
| 87 |
+
"prettyPrint": {
|
| 88 |
+
"default": "true",
|
| 89 |
+
"description": "Returns response with indentations and line breaks.",
|
| 90 |
+
"location": "query",
|
| 91 |
+
"type": "boolean"
|
| 92 |
+
},
|
| 93 |
+
"quotaUser": {
|
| 94 |
+
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| 95 |
+
"location": "query",
|
| 96 |
+
"type": "string"
|
| 97 |
+
},
|
| 98 |
+
"uploadType": {
|
| 99 |
+
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| 100 |
+
"location": "query",
|
| 101 |
+
"type": "string"
|
| 102 |
+
},
|
| 103 |
+
"upload_protocol": {
|
| 104 |
+
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| 105 |
+
"location": "query",
|
| 106 |
+
"type": "string"
|
| 107 |
+
}
|
| 108 |
+
},
|
| 109 |
+
"protocol": "rest",
|
| 110 |
+
"resources": {
|
| 111 |
+
"documents": {
|
| 112 |
+
"methods": {
|
| 113 |
+
"analyzeEntities": {
|
| 114 |
+
"description": "Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.",
|
| 115 |
+
"flatPath": "v1beta1/documents:analyzeEntities",
|
| 116 |
+
"httpMethod": "POST",
|
| 117 |
+
"id": "language.documents.analyzeEntities",
|
| 118 |
+
"parameterOrder": [],
|
| 119 |
+
"parameters": {},
|
| 120 |
+
"path": "v1beta1/documents:analyzeEntities",
|
| 121 |
+
"request": {
|
| 122 |
+
"$ref": "AnalyzeEntitiesRequest"
|
| 123 |
+
},
|
| 124 |
+
"response": {
|
| 125 |
+
"$ref": "AnalyzeEntitiesResponse"
|
| 126 |
+
},
|
| 127 |
+
"scopes": [
|
| 128 |
+
"https://www.googleapis.com/auth/cloud-language",
|
| 129 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 130 |
+
]
|
| 131 |
+
},
|
| 132 |
+
"analyzeSentiment": {
|
| 133 |
+
"description": "Analyzes the sentiment of the provided text.",
|
| 134 |
+
"flatPath": "v1beta1/documents:analyzeSentiment",
|
| 135 |
+
"httpMethod": "POST",
|
| 136 |
+
"id": "language.documents.analyzeSentiment",
|
| 137 |
+
"parameterOrder": [],
|
| 138 |
+
"parameters": {},
|
| 139 |
+
"path": "v1beta1/documents:analyzeSentiment",
|
| 140 |
+
"request": {
|
| 141 |
+
"$ref": "AnalyzeSentimentRequest"
|
| 142 |
+
},
|
| 143 |
+
"response": {
|
| 144 |
+
"$ref": "AnalyzeSentimentResponse"
|
| 145 |
+
},
|
| 146 |
+
"scopes": [
|
| 147 |
+
"https://www.googleapis.com/auth/cloud-language",
|
| 148 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 149 |
+
]
|
| 150 |
+
},
|
| 151 |
+
"analyzeSyntax": {
|
| 152 |
+
"description": "Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.",
|
| 153 |
+
"flatPath": "v1beta1/documents:analyzeSyntax",
|
| 154 |
+
"httpMethod": "POST",
|
| 155 |
+
"id": "language.documents.analyzeSyntax",
|
| 156 |
+
"parameterOrder": [],
|
| 157 |
+
"parameters": {},
|
| 158 |
+
"path": "v1beta1/documents:analyzeSyntax",
|
| 159 |
+
"request": {
|
| 160 |
+
"$ref": "AnalyzeSyntaxRequest"
|
| 161 |
+
},
|
| 162 |
+
"response": {
|
| 163 |
+
"$ref": "AnalyzeSyntaxResponse"
|
| 164 |
+
},
|
| 165 |
+
"scopes": [
|
| 166 |
+
"https://www.googleapis.com/auth/cloud-language",
|
| 167 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 168 |
+
]
|
| 169 |
+
},
|
| 170 |
+
"annotateText": {
|
| 171 |
+
"description": "A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.",
|
| 172 |
+
"flatPath": "v1beta1/documents:annotateText",
|
| 173 |
+
"httpMethod": "POST",
|
| 174 |
+
"id": "language.documents.annotateText",
|
| 175 |
+
"parameterOrder": [],
|
| 176 |
+
"parameters": {},
|
| 177 |
+
"path": "v1beta1/documents:annotateText",
|
| 178 |
+
"request": {
|
| 179 |
+
"$ref": "AnnotateTextRequest"
|
| 180 |
+
},
|
| 181 |
+
"response": {
|
| 182 |
+
"$ref": "AnnotateTextResponse"
|
| 183 |
+
},
|
| 184 |
+
"scopes": [
|
| 185 |
+
"https://www.googleapis.com/auth/cloud-language",
|
| 186 |
+
"https://www.googleapis.com/auth/cloud-platform"
|
| 187 |
+
]
|
| 188 |
+
}
|
| 189 |
+
}
|
| 190 |
+
}
|
| 191 |
+
},
|
| 192 |
+
"revision": "20230104",
|
| 193 |
+
"rootUrl": "https://language.googleapis.com/",
|
| 194 |
+
"schemas": {
|
| 195 |
+
"AnalyzeEntitiesRequest": {
|
| 196 |
+
"description": "The entity analysis request message.",
|
| 197 |
+
"id": "AnalyzeEntitiesRequest",
|
| 198 |
+
"properties": {
|
| 199 |
+
"document": {
|
| 200 |
+
"$ref": "Document",
|
| 201 |
+
"description": "Input document."
|
| 202 |
+
},
|
| 203 |
+
"encodingType": {
|
| 204 |
+
"description": "The encoding type used by the API to calculate offsets.",
|
| 205 |
+
"enum": [
|
| 206 |
+
"NONE",
|
| 207 |
+
"UTF8",
|
| 208 |
+
"UTF16",
|
| 209 |
+
"UTF32"
|
| 210 |
+
],
|
| 211 |
+
"enumDescriptions": [
|
| 212 |
+
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
|
| 213 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
|
| 214 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.",
|
| 215 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
|
| 216 |
+
],
|
| 217 |
+
"type": "string"
|
| 218 |
+
}
|
| 219 |
+
},
|
| 220 |
+
"type": "object"
|
| 221 |
+
},
|
| 222 |
+
"AnalyzeEntitiesResponse": {
|
| 223 |
+
"description": "The entity analysis response message.",
|
| 224 |
+
"id": "AnalyzeEntitiesResponse",
|
| 225 |
+
"properties": {
|
| 226 |
+
"entities": {
|
| 227 |
+
"description": "The recognized entities in the input document.",
|
| 228 |
+
"items": {
|
| 229 |
+
"$ref": "Entity"
|
| 230 |
+
},
|
| 231 |
+
"type": "array"
|
| 232 |
+
},
|
| 233 |
+
"language": {
|
| 234 |
+
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
|
| 235 |
+
"type": "string"
|
| 236 |
+
}
|
| 237 |
+
},
|
| 238 |
+
"type": "object"
|
| 239 |
+
},
|
| 240 |
+
"AnalyzeSentimentRequest": {
|
| 241 |
+
"description": "The sentiment analysis request message.",
|
| 242 |
+
"id": "AnalyzeSentimentRequest",
|
| 243 |
+
"properties": {
|
| 244 |
+
"document": {
|
| 245 |
+
"$ref": "Document",
|
| 246 |
+
"description": "Input document."
|
| 247 |
+
},
|
| 248 |
+
"encodingType": {
|
| 249 |
+
"description": "The encoding type used by the API to calculate sentence offsets for the sentence sentiment.",
|
| 250 |
+
"enum": [
|
| 251 |
+
"NONE",
|
| 252 |
+
"UTF8",
|
| 253 |
+
"UTF16",
|
| 254 |
+
"UTF32"
|
| 255 |
+
],
|
| 256 |
+
"enumDescriptions": [
|
| 257 |
+
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
|
| 258 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
|
| 259 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.",
|
| 260 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
|
| 261 |
+
],
|
| 262 |
+
"type": "string"
|
| 263 |
+
}
|
| 264 |
+
},
|
| 265 |
+
"type": "object"
|
| 266 |
+
},
|
| 267 |
+
"AnalyzeSentimentResponse": {
|
| 268 |
+
"description": "The sentiment analysis response message.",
|
| 269 |
+
"id": "AnalyzeSentimentResponse",
|
| 270 |
+
"properties": {
|
| 271 |
+
"documentSentiment": {
|
| 272 |
+
"$ref": "Sentiment",
|
| 273 |
+
"description": "The overall sentiment of the input document."
|
| 274 |
+
},
|
| 275 |
+
"language": {
|
| 276 |
+
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
|
| 277 |
+
"type": "string"
|
| 278 |
+
},
|
| 279 |
+
"sentences": {
|
| 280 |
+
"description": "The sentiment for all the sentences in the document.",
|
| 281 |
+
"items": {
|
| 282 |
+
"$ref": "Sentence"
|
| 283 |
+
},
|
| 284 |
+
"type": "array"
|
| 285 |
+
}
|
| 286 |
+
},
|
| 287 |
+
"type": "object"
|
| 288 |
+
},
|
| 289 |
+
"AnalyzeSyntaxRequest": {
|
| 290 |
+
"description": "The syntax analysis request message.",
|
| 291 |
+
"id": "AnalyzeSyntaxRequest",
|
| 292 |
+
"properties": {
|
| 293 |
+
"document": {
|
| 294 |
+
"$ref": "Document",
|
| 295 |
+
"description": "Input document."
|
| 296 |
+
},
|
| 297 |
+
"encodingType": {
|
| 298 |
+
"description": "The encoding type used by the API to calculate offsets.",
|
| 299 |
+
"enum": [
|
| 300 |
+
"NONE",
|
| 301 |
+
"UTF8",
|
| 302 |
+
"UTF16",
|
| 303 |
+
"UTF32"
|
| 304 |
+
],
|
| 305 |
+
"enumDescriptions": [
|
| 306 |
+
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
|
| 307 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
|
| 308 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.",
|
| 309 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
|
| 310 |
+
],
|
| 311 |
+
"type": "string"
|
| 312 |
+
}
|
| 313 |
+
},
|
| 314 |
+
"type": "object"
|
| 315 |
+
},
|
| 316 |
+
"AnalyzeSyntaxResponse": {
|
| 317 |
+
"description": "The syntax analysis response message.",
|
| 318 |
+
"id": "AnalyzeSyntaxResponse",
|
| 319 |
+
"properties": {
|
| 320 |
+
"language": {
|
| 321 |
+
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
|
| 322 |
+
"type": "string"
|
| 323 |
+
},
|
| 324 |
+
"sentences": {
|
| 325 |
+
"description": "Sentences in the input document.",
|
| 326 |
+
"items": {
|
| 327 |
+
"$ref": "Sentence"
|
| 328 |
+
},
|
| 329 |
+
"type": "array"
|
| 330 |
+
},
|
| 331 |
+
"tokens": {
|
| 332 |
+
"description": "Tokens, along with their syntactic information, in the input document.",
|
| 333 |
+
"items": {
|
| 334 |
+
"$ref": "Token"
|
| 335 |
+
},
|
| 336 |
+
"type": "array"
|
| 337 |
+
}
|
| 338 |
+
},
|
| 339 |
+
"type": "object"
|
| 340 |
+
},
|
| 341 |
+
"AnnotateTextRequest": {
|
| 342 |
+
"description": "The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.",
|
| 343 |
+
"id": "AnnotateTextRequest",
|
| 344 |
+
"properties": {
|
| 345 |
+
"document": {
|
| 346 |
+
"$ref": "Document",
|
| 347 |
+
"description": "Input document."
|
| 348 |
+
},
|
| 349 |
+
"encodingType": {
|
| 350 |
+
"description": "The encoding type used by the API to calculate offsets.",
|
| 351 |
+
"enum": [
|
| 352 |
+
"NONE",
|
| 353 |
+
"UTF8",
|
| 354 |
+
"UTF16",
|
| 355 |
+
"UTF32"
|
| 356 |
+
],
|
| 357 |
+
"enumDescriptions": [
|
| 358 |
+
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
|
| 359 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
|
| 360 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.",
|
| 361 |
+
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
|
| 362 |
+
],
|
| 363 |
+
"type": "string"
|
| 364 |
+
},
|
| 365 |
+
"features": {
|
| 366 |
+
"$ref": "Features",
|
| 367 |
+
"description": "The enabled features."
|
| 368 |
+
}
|
| 369 |
+
},
|
| 370 |
+
"type": "object"
|
| 371 |
+
},
|
| 372 |
+
"AnnotateTextResponse": {
|
| 373 |
+
"description": "The text annotations response message.",
|
| 374 |
+
"id": "AnnotateTextResponse",
|
| 375 |
+
"properties": {
|
| 376 |
+
"documentSentiment": {
|
| 377 |
+
"$ref": "Sentiment",
|
| 378 |
+
"description": "The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment."
|
| 379 |
+
},
|
| 380 |
+
"entities": {
|
| 381 |
+
"description": "Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.",
|
| 382 |
+
"items": {
|
| 383 |
+
"$ref": "Entity"
|
| 384 |
+
},
|
| 385 |
+
"type": "array"
|
| 386 |
+
},
|
| 387 |
+
"language": {
|
| 388 |
+
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
|
| 389 |
+
"type": "string"
|
| 390 |
+
},
|
| 391 |
+
"sentences": {
|
| 392 |
+
"description": "Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.",
|
| 393 |
+
"items": {
|
| 394 |
+
"$ref": "Sentence"
|
| 395 |
+
},
|
| 396 |
+
"type": "array"
|
| 397 |
+
},
|
| 398 |
+
"tokens": {
|
| 399 |
+
"description": "Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.",
|
| 400 |
+
"items": {
|
| 401 |
+
"$ref": "Token"
|
| 402 |
+
},
|
| 403 |
+
"type": "array"
|
| 404 |
+
}
|
| 405 |
+
},
|
| 406 |
+
"type": "object"
|
| 407 |
+
},
|
| 408 |
+
"DependencyEdge": {
|
| 409 |
+
"description": "Represents dependency parse tree information for a token.",
|
| 410 |
+
"id": "DependencyEdge",
|
| 411 |
+
"properties": {
|
| 412 |
+
"headTokenIndex": {
|
| 413 |
+
"description": "Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index.",
|
| 414 |
+
"format": "int32",
|
| 415 |
+
"type": "integer"
|
| 416 |
+
},
|
| 417 |
+
"label": {
|
| 418 |
+
"description": "The parse label for the token.",
|
| 419 |
+
"enum": [
|
| 420 |
+
"UNKNOWN",
|
| 421 |
+
"ABBREV",
|
| 422 |
+
"ACOMP",
|
| 423 |
+
"ADVCL",
|
| 424 |
+
"ADVMOD",
|
| 425 |
+
"AMOD",
|
| 426 |
+
"APPOS",
|
| 427 |
+
"ATTR",
|
| 428 |
+
"AUX",
|
| 429 |
+
"AUXPASS",
|
| 430 |
+
"CC",
|
| 431 |
+
"CCOMP",
|
| 432 |
+
"CONJ",
|
| 433 |
+
"CSUBJ",
|
| 434 |
+
"CSUBJPASS",
|
| 435 |
+
"DEP",
|
| 436 |
+
"DET",
|
| 437 |
+
"DISCOURSE",
|
| 438 |
+
"DOBJ",
|
| 439 |
+
"EXPL",
|
| 440 |
+
"GOESWITH",
|
| 441 |
+
"IOBJ",
|
| 442 |
+
"MARK",
|
| 443 |
+
"MWE",
|
| 444 |
+
"MWV",
|
| 445 |
+
"NEG",
|
| 446 |
+
"NN",
|
| 447 |
+
"NPADVMOD",
|
| 448 |
+
"NSUBJ",
|
| 449 |
+
"NSUBJPASS",
|
| 450 |
+
"NUM",
|
| 451 |
+
"NUMBER",
|
| 452 |
+
"P",
|
| 453 |
+
"PARATAXIS",
|
| 454 |
+
"PARTMOD",
|
| 455 |
+
"PCOMP",
|
| 456 |
+
"POBJ",
|
| 457 |
+
"POSS",
|
| 458 |
+
"POSTNEG",
|
| 459 |
+
"PRECOMP",
|
| 460 |
+
"PRECONJ",
|
| 461 |
+
"PREDET",
|
| 462 |
+
"PREF",
|
| 463 |
+
"PREP",
|
| 464 |
+
"PRONL",
|
| 465 |
+
"PRT",
|
| 466 |
+
"PS",
|
| 467 |
+
"QUANTMOD",
|
| 468 |
+
"RCMOD",
|
| 469 |
+
"RCMODREL",
|
| 470 |
+
"RDROP",
|
| 471 |
+
"REF",
|
| 472 |
+
"REMNANT",
|
| 473 |
+
"REPARANDUM",
|
| 474 |
+
"ROOT",
|
| 475 |
+
"SNUM",
|
| 476 |
+
"SUFF",
|
| 477 |
+
"TMOD",
|
| 478 |
+
"TOPIC",
|
| 479 |
+
"VMOD",
|
| 480 |
+
"VOCATIVE",
|
| 481 |
+
"XCOMP",
|
| 482 |
+
"SUFFIX",
|
| 483 |
+
"TITLE",
|
| 484 |
+
"ADVPHMOD",
|
| 485 |
+
"AUXCAUS",
|
| 486 |
+
"AUXVV",
|
| 487 |
+
"DTMOD",
|
| 488 |
+
"FOREIGN",
|
| 489 |
+
"KW",
|
| 490 |
+
"LIST",
|
| 491 |
+
"NOMC",
|
| 492 |
+
"NOMCSUBJ",
|
| 493 |
+
"NOMCSUBJPASS",
|
| 494 |
+
"NUMC",
|
| 495 |
+
"COP",
|
| 496 |
+
"DISLOCATED",
|
| 497 |
+
"ASP",
|
| 498 |
+
"GMOD",
|
| 499 |
+
"GOBJ",
|
| 500 |
+
"INFMOD",
|
| 501 |
+
"MES",
|
| 502 |
+
"NCOMP"
|
| 503 |
+
],
|
| 504 |
+
"enumDescriptions": [
|
| 505 |
+
"Unknown",
|
| 506 |
+
"Abbreviation modifier",
|
| 507 |
+
"Adjectival complement",
|
| 508 |
+
"Adverbial clause modifier",
|
| 509 |
+
"Adverbial modifier",
|
| 510 |
+
"Adjectival modifier of an NP",
|
| 511 |
+
"Appositional modifier of an NP",
|
| 512 |
+
"Attribute dependent of a copular verb",
|
| 513 |
+
"Auxiliary (non-main) verb",
|
| 514 |
+
"Passive auxiliary",
|
| 515 |
+
"Coordinating conjunction",
|
| 516 |
+
"Clausal complement of a verb or adjective",
|
| 517 |
+
"Conjunct",
|
| 518 |
+
"Clausal subject",
|
| 519 |
+
"Clausal passive subject",
|
| 520 |
+
"Dependency (unable to determine)",
|
| 521 |
+
"Determiner",
|
| 522 |
+
"Discourse",
|
| 523 |
+
"Direct object",
|
| 524 |
+
"Expletive",
|
| 525 |
+
"Goes with (part of a word in a text not well edited)",
|
| 526 |
+
"Indirect object",
|
| 527 |
+
"Marker (word introducing a subordinate clause)",
|
| 528 |
+
"Multi-word expression",
|
| 529 |
+
"Multi-word verbal expression",
|
| 530 |
+
"Negation modifier",
|
| 531 |
+
"Noun compound modifier",
|
| 532 |
+
"Noun phrase used as an adverbial modifier",
|
| 533 |
+
"Nominal subject",
|
| 534 |
+
"Passive nominal subject",
|
| 535 |
+
"Numeric modifier of a noun",
|
| 536 |
+
"Element of compound number",
|
| 537 |
+
"Punctuation mark",
|
| 538 |
+
"Parataxis relation",
|
| 539 |
+
"Participial modifier",
|
| 540 |
+
"The complement of a preposition is a clause",
|
| 541 |
+
"Object of a preposition",
|
| 542 |
+
"Possession modifier",
|
| 543 |
+
"Postverbal negative particle",
|
| 544 |
+
"Predicate complement",
|
| 545 |
+
"Preconjunt",
|
| 546 |
+
"Predeterminer",
|
| 547 |
+
"Prefix",
|
| 548 |
+
"Prepositional modifier",
|
| 549 |
+
"The relationship between a verb and verbal morpheme",
|
| 550 |
+
"Particle",
|
| 551 |
+
"Associative or possessive marker",
|
| 552 |
+
"Quantifier phrase modifier",
|
| 553 |
+
"Relative clause modifier",
|
| 554 |
+
"Complementizer in relative clause",
|
| 555 |
+
"Ellipsis without a preceding predicate",
|
| 556 |
+
"Referent",
|
| 557 |
+
"Remnant",
|
| 558 |
+
"Reparandum",
|
| 559 |
+
"Root",
|
| 560 |
+
"Suffix specifying a unit of number",
|
| 561 |
+
"Suffix",
|
| 562 |
+
"Temporal modifier",
|
| 563 |
+
"Topic marker",
|
| 564 |
+
"Clause headed by an infinite form of the verb that modifies a noun",
|
| 565 |
+
"Vocative",
|
| 566 |
+
"Open clausal complement",
|
| 567 |
+
"Name suffix",
|
| 568 |
+
"Name title",
|
| 569 |
+
"Adverbial phrase modifier",
|
| 570 |
+
"Causative auxiliary",
|
| 571 |
+
"Helper auxiliary",
|
| 572 |
+
"Rentaishi (Prenominal modifier)",
|
| 573 |
+
"Foreign words",
|
| 574 |
+
"Keyword",
|
| 575 |
+
"List for chains of comparable items",
|
| 576 |
+
"Nominalized clause",
|
| 577 |
+
"Nominalized clausal subject",
|
| 578 |
+
"Nominalized clausal passive",
|
| 579 |
+
"Compound of numeric modifier",
|
| 580 |
+
"Copula",
|
| 581 |
+
"Dislocated relation (for fronted/topicalized elements)",
|
| 582 |
+
"Aspect marker",
|
| 583 |
+
"Genitive modifier",
|
| 584 |
+
"Genitive object",
|
| 585 |
+
"Infinitival modifier",
|
| 586 |
+
"Measure",
|
| 587 |
+
"Nominal complement of a noun"
|
| 588 |
+
],
|
| 589 |
+
"type": "string"
|
| 590 |
+
}
|
| 591 |
+
},
|
| 592 |
+
"type": "object"
|
| 593 |
+
},
|
| 594 |
+
"Document": {
|
| 595 |
+
"description": "Represents the input to API methods.",
|
| 596 |
+
"id": "Document",
|
| 597 |
+
"properties": {
|
| 598 |
+
"content": {
|
| 599 |
+
"description": "The content of the input in string format. Cloud audit logging exempt since it is based on user data.",
|
| 600 |
+
"type": "string"
|
| 601 |
+
},
|
| 602 |
+
"gcsContentUri": {
|
| 603 |
+
"description": "The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.",
|
| 604 |
+
"type": "string"
|
| 605 |
+
},
|
| 606 |
+
"language": {
|
| 607 |
+
"description": "The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.",
|
| 608 |
+
"type": "string"
|
| 609 |
+
},
|
| 610 |
+
"type": {
|
| 611 |
+
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.",
|
| 612 |
+
"enum": [
|
| 613 |
+
"TYPE_UNSPECIFIED",
|
| 614 |
+
"PLAIN_TEXT",
|
| 615 |
+
"HTML"
|
| 616 |
+
],
|
| 617 |
+
"enumDescriptions": [
|
| 618 |
+
"The content type is not specified.",
|
| 619 |
+
"Plain text",
|
| 620 |
+
"HTML"
|
| 621 |
+
],
|
| 622 |
+
"type": "string"
|
| 623 |
+
}
|
| 624 |
+
},
|
| 625 |
+
"type": "object"
|
| 626 |
+
},
|
| 627 |
+
"Entity": {
|
| 628 |
+
"description": "Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.",
|
| 629 |
+
"id": "Entity",
|
| 630 |
+
"properties": {
|
| 631 |
+
"mentions": {
|
| 632 |
+
"description": "The mentions of this entity in the input document. The API currently supports proper noun mentions.",
|
| 633 |
+
"items": {
|
| 634 |
+
"$ref": "EntityMention"
|
| 635 |
+
},
|
| 636 |
+
"type": "array"
|
| 637 |
+
},
|
| 638 |
+
"metadata": {
|
| 639 |
+
"additionalProperties": {
|
| 640 |
+
"type": "string"
|
| 641 |
+
},
|
| 642 |
+
"description": "Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if available. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
|
| 643 |
+
"type": "object"
|
| 644 |
+
},
|
| 645 |
+
"name": {
|
| 646 |
+
"description": "The representative name for the entity.",
|
| 647 |
+
"type": "string"
|
| 648 |
+
},
|
| 649 |
+
"salience": {
|
| 650 |
+
"description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.",
|
| 651 |
+
"format": "float",
|
| 652 |
+
"type": "number"
|
| 653 |
+
},
|
| 654 |
+
"type": {
|
| 655 |
+
"description": "The entity type.",
|
| 656 |
+
"enum": [
|
| 657 |
+
"UNKNOWN",
|
| 658 |
+
"PERSON",
|
| 659 |
+
"LOCATION",
|
| 660 |
+
"ORGANIZATION",
|
| 661 |
+
"EVENT",
|
| 662 |
+
"WORK_OF_ART",
|
| 663 |
+
"CONSUMER_GOOD",
|
| 664 |
+
"OTHER"
|
| 665 |
+
],
|
| 666 |
+
"enumDescriptions": [
|
| 667 |
+
"Unknown",
|
| 668 |
+
"Person",
|
| 669 |
+
"Location",
|
| 670 |
+
"Organization",
|
| 671 |
+
"Event",
|
| 672 |
+
"Work of art",
|
| 673 |
+
"Consumer goods",
|
| 674 |
+
"Other types"
|
| 675 |
+
],
|
| 676 |
+
"type": "string"
|
| 677 |
+
}
|
| 678 |
+
},
|
| 679 |
+
"type": "object"
|
| 680 |
+
},
|
| 681 |
+
"EntityMention": {
|
| 682 |
+
"description": "Represents a mention for an entity in the text. Currently, proper noun mentions are supported.",
|
| 683 |
+
"id": "EntityMention",
|
| 684 |
+
"properties": {
|
| 685 |
+
"text": {
|
| 686 |
+
"$ref": "TextSpan",
|
| 687 |
+
"description": "The mention text."
|
| 688 |
+
},
|
| 689 |
+
"type": {
|
| 690 |
+
"description": "The type of the entity mention.",
|
| 691 |
+
"enum": [
|
| 692 |
+
"TYPE_UNKNOWN",
|
| 693 |
+
"PROPER",
|
| 694 |
+
"COMMON"
|
| 695 |
+
],
|
| 696 |
+
"enumDescriptions": [
|
| 697 |
+
"Unknown",
|
| 698 |
+
"Proper name",
|
| 699 |
+
"Common noun (or noun compound)"
|
| 700 |
+
],
|
| 701 |
+
"type": "string"
|
| 702 |
+
}
|
| 703 |
+
},
|
| 704 |
+
"type": "object"
|
| 705 |
+
},
|
| 706 |
+
"Features": {
|
| 707 |
+
"description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.",
|
| 708 |
+
"id": "Features",
|
| 709 |
+
"properties": {
|
| 710 |
+
"extractDocumentSentiment": {
|
| 711 |
+
"description": "Extract document-level sentiment.",
|
| 712 |
+
"type": "boolean"
|
| 713 |
+
},
|
| 714 |
+
"extractEntities": {
|
| 715 |
+
"description": "Extract entities.",
|
| 716 |
+
"type": "boolean"
|
| 717 |
+
},
|
| 718 |
+
"extractSyntax": {
|
| 719 |
+
"description": "Extract syntax information.",
|
| 720 |
+
"type": "boolean"
|
| 721 |
+
}
|
| 722 |
+
},
|
| 723 |
+
"type": "object"
|
| 724 |
+
},
|
| 725 |
+
"PartOfSpeech": {
|
| 726 |
+
"description": "Represents part of speech information for a token.",
|
| 727 |
+
"id": "PartOfSpeech",
|
| 728 |
+
"properties": {
|
| 729 |
+
"aspect": {
|
| 730 |
+
"description": "The grammatical aspect.",
|
| 731 |
+
"enum": [
|
| 732 |
+
"ASPECT_UNKNOWN",
|
| 733 |
+
"PERFECTIVE",
|
| 734 |
+
"IMPERFECTIVE",
|
| 735 |
+
"PROGRESSIVE"
|
| 736 |
+
],
|
| 737 |
+
"enumDescriptions": [
|
| 738 |
+
"Aspect is not applicable in the analyzed language or is not predicted.",
|
| 739 |
+
"Perfective",
|
| 740 |
+
"Imperfective",
|
| 741 |
+
"Progressive"
|
| 742 |
+
],
|
| 743 |
+
"type": "string"
|
| 744 |
+
},
|
| 745 |
+
"case": {
|
| 746 |
+
"description": "The grammatical case.",
|
| 747 |
+
"enum": [
|
| 748 |
+
"CASE_UNKNOWN",
|
| 749 |
+
"ACCUSATIVE",
|
| 750 |
+
"ADVERBIAL",
|
| 751 |
+
"COMPLEMENTIVE",
|
| 752 |
+
"DATIVE",
|
| 753 |
+
"GENITIVE",
|
| 754 |
+
"INSTRUMENTAL",
|
| 755 |
+
"LOCATIVE",
|
| 756 |
+
"NOMINATIVE",
|
| 757 |
+
"OBLIQUE",
|
| 758 |
+
"PARTITIVE",
|
| 759 |
+
"PREPOSITIONAL",
|
| 760 |
+
"REFLEXIVE_CASE",
|
| 761 |
+
"RELATIVE_CASE",
|
| 762 |
+
"VOCATIVE"
|
| 763 |
+
],
|
| 764 |
+
"enumDescriptions": [
|
| 765 |
+
"Case is not applicable in the analyzed language or is not predicted.",
|
| 766 |
+
"Accusative",
|
| 767 |
+
"Adverbial",
|
| 768 |
+
"Complementive",
|
| 769 |
+
"Dative",
|
| 770 |
+
"Genitive",
|
| 771 |
+
"Instrumental",
|
| 772 |
+
"Locative",
|
| 773 |
+
"Nominative",
|
| 774 |
+
"Oblique",
|
| 775 |
+
"Partitive",
|
| 776 |
+
"Prepositional",
|
| 777 |
+
"Reflexive",
|
| 778 |
+
"Relative",
|
| 779 |
+
"Vocative"
|
| 780 |
+
],
|
| 781 |
+
"type": "string"
|
| 782 |
+
},
|
| 783 |
+
"form": {
|
| 784 |
+
"description": "The grammatical form.",
|
| 785 |
+
"enum": [
|
| 786 |
+
"FORM_UNKNOWN",
|
| 787 |
+
"ADNOMIAL",
|
| 788 |
+
"AUXILIARY",
|
| 789 |
+
"COMPLEMENTIZER",
|
| 790 |
+
"FINAL_ENDING",
|
| 791 |
+
"GERUND",
|
| 792 |
+
"REALIS",
|
| 793 |
+
"IRREALIS",
|
| 794 |
+
"SHORT",
|
| 795 |
+
"LONG",
|
| 796 |
+
"ORDER",
|
| 797 |
+
"SPECIFIC"
|
| 798 |
+
],
|
| 799 |
+
"enumDescriptions": [
|
| 800 |
+
"Form is not applicable in the analyzed language or is not predicted.",
|
| 801 |
+
"Adnomial",
|
| 802 |
+
"Auxiliary",
|
| 803 |
+
"Complementizer",
|
| 804 |
+
"Final ending",
|
| 805 |
+
"Gerund",
|
| 806 |
+
"Realis",
|
| 807 |
+
"Irrealis",
|
| 808 |
+
"Short form",
|
| 809 |
+
"Long form",
|
| 810 |
+
"Order form",
|
| 811 |
+
"Specific form"
|
| 812 |
+
],
|
| 813 |
+
"type": "string"
|
| 814 |
+
},
|
| 815 |
+
"gender": {
|
| 816 |
+
"description": "The grammatical gender.",
|
| 817 |
+
"enum": [
|
| 818 |
+
"GENDER_UNKNOWN",
|
| 819 |
+
"FEMININE",
|
| 820 |
+
"MASCULINE",
|
| 821 |
+
"NEUTER"
|
| 822 |
+
],
|
| 823 |
+
"enumDescriptions": [
|
| 824 |
+
"Gender is not applicable in the analyzed language or is not predicted.",
|
| 825 |
+
"Feminine",
|
| 826 |
+
"Masculine",
|
| 827 |
+
"Neuter"
|
| 828 |
+
],
|
| 829 |
+
"type": "string"
|
| 830 |
+
},
|
| 831 |
+
"mood": {
|
| 832 |
+
"description": "The grammatical mood.",
|
| 833 |
+
"enum": [
|
| 834 |
+
"MOOD_UNKNOWN",
|
| 835 |
+
"CONDITIONAL_MOOD",
|
| 836 |
+
"IMPERATIVE",
|
| 837 |
+
"INDICATIVE",
|
| 838 |
+
"INTERROGATIVE",
|
| 839 |
+
"JUSSIVE",
|
| 840 |
+
"SUBJUNCTIVE"
|
| 841 |
+
],
|
| 842 |
+
"enumDescriptions": [
|
| 843 |
+
"Mood is not applicable in the analyzed language or is not predicted.",
|
| 844 |
+
"Conditional",
|
| 845 |
+
"Imperative",
|
| 846 |
+
"Indicative",
|
| 847 |
+
"Interrogative",
|
| 848 |
+
"Jussive",
|
| 849 |
+
"Subjunctive"
|
| 850 |
+
],
|
| 851 |
+
"type": "string"
|
| 852 |
+
},
|
| 853 |
+
"number": {
|
| 854 |
+
"description": "The grammatical number.",
|
| 855 |
+
"enum": [
|
| 856 |
+
"NUMBER_UNKNOWN",
|
| 857 |
+
"SINGULAR",
|
| 858 |
+
"PLURAL",
|
| 859 |
+
"DUAL"
|
| 860 |
+
],
|
| 861 |
+
"enumDescriptions": [
|
| 862 |
+
"Number is not applicable in the analyzed language or is not predicted.",
|
| 863 |
+
"Singular",
|
| 864 |
+
"Plural",
|
| 865 |
+
"Dual"
|
| 866 |
+
],
|
| 867 |
+
"type": "string"
|
| 868 |
+
},
|
| 869 |
+
"person": {
|
| 870 |
+
"description": "The grammatical person.",
|
| 871 |
+
"enum": [
|
| 872 |
+
"PERSON_UNKNOWN",
|
| 873 |
+
"FIRST",
|
| 874 |
+
"SECOND",
|
| 875 |
+
"THIRD",
|
| 876 |
+
"REFLEXIVE_PERSON"
|
| 877 |
+
],
|
| 878 |
+
"enumDescriptions": [
|
| 879 |
+
"Person is not applicable in the analyzed language or is not predicted.",
|
| 880 |
+
"First",
|
| 881 |
+
"Second",
|
| 882 |
+
"Third",
|
| 883 |
+
"Reflexive"
|
| 884 |
+
],
|
| 885 |
+
"type": "string"
|
| 886 |
+
},
|
| 887 |
+
"proper": {
|
| 888 |
+
"description": "The grammatical properness.",
|
| 889 |
+
"enum": [
|
| 890 |
+
"PROPER_UNKNOWN",
|
| 891 |
+
"PROPER",
|
| 892 |
+
"NOT_PROPER"
|
| 893 |
+
],
|
| 894 |
+
"enumDescriptions": [
|
| 895 |
+
"Proper is not applicable in the analyzed language or is not predicted.",
|
| 896 |
+
"Proper",
|
| 897 |
+
"Not proper"
|
| 898 |
+
],
|
| 899 |
+
"type": "string"
|
| 900 |
+
},
|
| 901 |
+
"reciprocity": {
|
| 902 |
+
"description": "The grammatical reciprocity.",
|
| 903 |
+
"enum": [
|
| 904 |
+
"RECIPROCITY_UNKNOWN",
|
| 905 |
+
"RECIPROCAL",
|
| 906 |
+
"NON_RECIPROCAL"
|
| 907 |
+
],
|
| 908 |
+
"enumDescriptions": [
|
| 909 |
+
"Reciprocity is not applicable in the analyzed language or is not predicted.",
|
| 910 |
+
"Reciprocal",
|
| 911 |
+
"Non-reciprocal"
|
| 912 |
+
],
|
| 913 |
+
"type": "string"
|
| 914 |
+
},
|
| 915 |
+
"tag": {
|
| 916 |
+
"description": "The part of speech tag.",
|
| 917 |
+
"enum": [
|
| 918 |
+
"UNKNOWN",
|
| 919 |
+
"ADJ",
|
| 920 |
+
"ADP",
|
| 921 |
+
"ADV",
|
| 922 |
+
"CONJ",
|
| 923 |
+
"DET",
|
| 924 |
+
"NOUN",
|
| 925 |
+
"NUM",
|
| 926 |
+
"PRON",
|
| 927 |
+
"PRT",
|
| 928 |
+
"PUNCT",
|
| 929 |
+
"VERB",
|
| 930 |
+
"X",
|
| 931 |
+
"AFFIX"
|
| 932 |
+
],
|
| 933 |
+
"enumDescriptions": [
|
| 934 |
+
"Unknown",
|
| 935 |
+
"Adjective",
|
| 936 |
+
"Adposition (preposition and postposition)",
|
| 937 |
+
"Adverb",
|
| 938 |
+
"Conjunction",
|
| 939 |
+
"Determiner",
|
| 940 |
+
"Noun (common and proper)",
|
| 941 |
+
"Cardinal number",
|
| 942 |
+
"Pronoun",
|
| 943 |
+
"Particle or other function word",
|
| 944 |
+
"Punctuation",
|
| 945 |
+
"Verb (all tenses and modes)",
|
| 946 |
+
"Other: foreign words, typos, abbreviations",
|
| 947 |
+
"Affix"
|
| 948 |
+
],
|
| 949 |
+
"type": "string"
|
| 950 |
+
},
|
| 951 |
+
"tense": {
|
| 952 |
+
"description": "The grammatical tense.",
|
| 953 |
+
"enum": [
|
| 954 |
+
"TENSE_UNKNOWN",
|
| 955 |
+
"CONDITIONAL_TENSE",
|
| 956 |
+
"FUTURE",
|
| 957 |
+
"PAST",
|
| 958 |
+
"PRESENT",
|
| 959 |
+
"IMPERFECT",
|
| 960 |
+
"PLUPERFECT"
|
| 961 |
+
],
|
| 962 |
+
"enumDescriptions": [
|
| 963 |
+
"Tense is not applicable in the analyzed language or is not predicted.",
|
| 964 |
+
"Conditional",
|
| 965 |
+
"Future",
|
| 966 |
+
"Past",
|
| 967 |
+
"Present",
|
| 968 |
+
"Imperfect",
|
| 969 |
+
"Pluperfect"
|
| 970 |
+
],
|
| 971 |
+
"type": "string"
|
| 972 |
+
},
|
| 973 |
+
"voice": {
|
| 974 |
+
"description": "The grammatical voice.",
|
| 975 |
+
"enum": [
|
| 976 |
+
"VOICE_UNKNOWN",
|
| 977 |
+
"ACTIVE",
|
| 978 |
+
"CAUSATIVE",
|
| 979 |
+
"PASSIVE"
|
| 980 |
+
],
|
| 981 |
+
"enumDescriptions": [
|
| 982 |
+
"Voice is not applicable in the analyzed language or is not predicted.",
|
| 983 |
+
"Active",
|
| 984 |
+
"Causative",
|
| 985 |
+
"Passive"
|
| 986 |
+
],
|
| 987 |
+
"type": "string"
|
| 988 |
+
}
|
| 989 |
+
},
|
| 990 |
+
"type": "object"
|
| 991 |
+
},
|
| 992 |
+
"Sentence": {
|
| 993 |
+
"description": "Represents a sentence in the input document.",
|
| 994 |
+
"id": "Sentence",
|
| 995 |
+
"properties": {
|
| 996 |
+
"sentiment": {
|
| 997 |
+
"$ref": "Sentiment",
|
| 998 |
+
"description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence."
|
| 999 |
+
},
|
| 1000 |
+
"text": {
|
| 1001 |
+
"$ref": "TextSpan",
|
| 1002 |
+
"description": "The sentence text."
|
| 1003 |
+
}
|
| 1004 |
+
},
|
| 1005 |
+
"type": "object"
|
| 1006 |
+
},
|
| 1007 |
+
"Sentiment": {
|
| 1008 |
+
"description": "Represents the feeling associated with the entire text or entities in the text.",
|
| 1009 |
+
"id": "Sentiment",
|
| 1010 |
+
"properties": {
|
| 1011 |
+
"magnitude": {
|
| 1012 |
+
"description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).",
|
| 1013 |
+
"format": "float",
|
| 1014 |
+
"type": "number"
|
| 1015 |
+
},
|
| 1016 |
+
"polarity": {
|
| 1017 |
+
"description": "DEPRECATED FIELD - This field is being deprecated in favor of score. Please refer to our documentation at https://cloud.google.com/natural-language/docs for more information.",
|
| 1018 |
+
"format": "float",
|
| 1019 |
+
"type": "number"
|
| 1020 |
+
},
|
| 1021 |
+
"score": {
|
| 1022 |
+
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).",
|
| 1023 |
+
"format": "float",
|
| 1024 |
+
"type": "number"
|
| 1025 |
+
}
|
| 1026 |
+
},
|
| 1027 |
+
"type": "object"
|
| 1028 |
+
},
|
| 1029 |
+
"Status": {
|
| 1030 |
+
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
|
| 1031 |
+
"id": "Status",
|
| 1032 |
+
"properties": {
|
| 1033 |
+
"code": {
|
| 1034 |
+
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
| 1035 |
+
"format": "int32",
|
| 1036 |
+
"type": "integer"
|
| 1037 |
+
},
|
| 1038 |
+
"details": {
|
| 1039 |
+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
| 1040 |
+
"items": {
|
| 1041 |
+
"additionalProperties": {
|
| 1042 |
+
"description": "Properties of the object. Contains field @type with type URL.",
|
| 1043 |
+
"type": "any"
|
| 1044 |
+
},
|
| 1045 |
+
"type": "object"
|
| 1046 |
+
},
|
| 1047 |
+
"type": "array"
|
| 1048 |
+
},
|
| 1049 |
+
"message": {
|
| 1050 |
+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
|
| 1051 |
+
"type": "string"
|
| 1052 |
+
}
|
| 1053 |
+
},
|
| 1054 |
+
"type": "object"
|
| 1055 |
+
},
|
| 1056 |
+
"TextSpan": {
|
| 1057 |
+
"description": "Represents an output piece of text.",
|
| 1058 |
+
"id": "TextSpan",
|
| 1059 |
+
"properties": {
|
| 1060 |
+
"beginOffset": {
|
| 1061 |
+
"description": "The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.",
|
| 1062 |
+
"format": "int32",
|
| 1063 |
+
"type": "integer"
|
| 1064 |
+
},
|
| 1065 |
+
"content": {
|
| 1066 |
+
"description": "The content of the output text.",
|
| 1067 |
+
"type": "string"
|
| 1068 |
+
}
|
| 1069 |
+
},
|
| 1070 |
+
"type": "object"
|
| 1071 |
+
},
|
| 1072 |
+
"Token": {
|
| 1073 |
+
"description": "Represents the smallest syntactic building block of the text.",
|
| 1074 |
+
"id": "Token",
|
| 1075 |
+
"properties": {
|
| 1076 |
+
"dependencyEdge": {
|
| 1077 |
+
"$ref": "DependencyEdge",
|
| 1078 |
+
"description": "Dependency tree parse for this token."
|
| 1079 |
+
},
|
| 1080 |
+
"lemma": {
|
| 1081 |
+
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
|
| 1082 |
+
"type": "string"
|
| 1083 |
+
},
|
| 1084 |
+
"partOfSpeech": {
|
| 1085 |
+
"$ref": "PartOfSpeech",
|
| 1086 |
+
"description": "Parts of speech tag for this token."
|
| 1087 |
+
},
|
| 1088 |
+
"text": {
|
| 1089 |
+
"$ref": "TextSpan",
|
| 1090 |
+
"description": "The token text."
|
| 1091 |
+
}
|
| 1092 |
+
},
|
| 1093 |
+
"type": "object"
|
| 1094 |
+
}
|
| 1095 |
+
},
|
| 1096 |
+
"servicePath": "",
|
| 1097 |
+
"title": "Cloud Natural Language API",
|
| 1098 |
+
"version": "v1beta1",
|
| 1099 |
+
"version_module": true
|
| 1100 |
+
}
|