OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 5 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
6 "description": "View your data across Google Cloud Platform
services" | 6 "description": "View your data across Google Cloud Platform
services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
9 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
10 } | 10 } |
(...skipping 10 matching lines...) Expand all Loading... |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "cloudresourcemanager:v2beta1", | 25 "id": "cloudresourcemanager:v2beta1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "cloudresourcemanager", | 27 "name": "cloudresourcemanager", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
| 31 "key": { |
| 32 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "access_token": { |
| 37 "description": "OAuth access token.", |
| 38 "location": "query", |
| 39 "type": "string" |
| 40 }, |
| 41 "quotaUser": { |
| 42 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
31 "pp": { | 46 "pp": { |
32 "default": "true", | 47 "default": "true", |
33 "description": "Pretty-print response.", | 48 "description": "Pretty-print response.", |
34 "location": "query", | 49 "location": "query", |
35 "type": "boolean" | 50 "type": "boolean" |
36 }, | 51 }, |
| 52 "oauth_token": { |
| 53 "description": "OAuth 2.0 token for the current user.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
37 "bearer_token": { | 57 "bearer_token": { |
38 "description": "OAuth bearer token.", | 58 "description": "OAuth bearer token.", |
39 "location": "query", | 59 "location": "query", |
40 "type": "string" | 60 "type": "string" |
41 }, | 61 }, |
42 "oauth_token": { | |
43 "description": "OAuth 2.0 token for the current user.", | |
44 "location": "query", | |
45 "type": "string" | |
46 }, | |
47 "upload_protocol": { | 62 "upload_protocol": { |
48 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
49 "location": "query", | 64 "location": "query", |
50 "type": "string" | 65 "type": "string" |
51 }, | 66 }, |
52 "prettyPrint": { | 67 "prettyPrint": { |
53 "default": "true", | 68 "default": "true", |
54 "description": "Returns response with indentations and line breaks."
, | 69 "description": "Returns response with indentations and line breaks."
, |
55 "location": "query", | 70 "location": "query", |
56 "type": "boolean" | 71 "type": "boolean" |
57 }, | 72 }, |
58 "uploadType": { | 73 "uploadType": { |
59 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 74 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
60 "location": "query", | 75 "location": "query", |
61 "type": "string" | 76 "type": "string" |
62 }, | 77 }, |
63 "fields": { | 78 "fields": { |
64 "description": "Selector specifying which fields to include in a par
tial response.", | 79 "description": "Selector specifying which fields to include in a par
tial response.", |
65 "location": "query", | 80 "location": "query", |
66 "type": "string" | 81 "type": "string" |
67 }, | 82 }, |
| 83 "callback": { |
| 84 "description": "JSONP", |
| 85 "location": "query", |
| 86 "type": "string" |
| 87 }, |
68 "$.xgafv": { | 88 "$.xgafv": { |
69 "description": "V1 error format.", | 89 "description": "V1 error format.", |
70 "enum": [ | 90 "enum": [ |
71 "1", | 91 "1", |
72 "2" | 92 "2" |
73 ], | 93 ], |
74 "enumDescriptions": [ | 94 "enumDescriptions": [ |
75 "v1 error format", | 95 "v1 error format", |
76 "v2 error format" | 96 "v2 error format" |
77 ], | 97 ], |
78 "location": "query", | 98 "location": "query", |
79 "type": "string" | 99 "type": "string" |
80 }, | 100 }, |
81 "callback": { | |
82 "description": "JSONP", | |
83 "location": "query", | |
84 "type": "string" | |
85 }, | |
86 "alt": { | 101 "alt": { |
87 "default": "json", | 102 "default": "json", |
88 "description": "Data format for response.", | 103 "description": "Data format for response.", |
89 "enum": [ | 104 "enum": [ |
90 "json", | 105 "json", |
91 "media", | 106 "media", |
92 "proto" | 107 "proto" |
93 ], | 108 ], |
94 "enumDescriptions": [ | 109 "enumDescriptions": [ |
95 "Responses with Content-Type of application/json", | 110 "Responses with Content-Type of application/json", |
96 "Media download with context-dependent Content-Type", | 111 "Media download with context-dependent Content-Type", |
97 "Responses with Content-Type of application/x-protobuf" | 112 "Responses with Content-Type of application/x-protobuf" |
98 ], | 113 ], |
99 "location": "query", | 114 "location": "query", |
100 "type": "string" | 115 "type": "string" |
101 }, | |
102 "access_token": { | |
103 "description": "OAuth access token.", | |
104 "location": "query", | |
105 "type": "string" | |
106 }, | |
107 "key": { | |
108 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
109 "location": "query", | |
110 "type": "string" | |
111 }, | |
112 "quotaUser": { | |
113 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "folders": { | 120 "folders": { |
121 "methods": { | 121 "methods": { |
122 "search": { | |
123 "description": "Search for folders that match specific filte
r criteria.\nSearch provides an eventually consistent view of the folders a user
has\naccess to which meet the specified filter criteria.\n\nThis will only retu
rn folders on which the caller has the\npermission `resourcemanager.folders.get`
.", | |
124 "httpMethod": "POST", | |
125 "id": "cloudresourcemanager.folders.search", | |
126 "parameterOrder": [], | |
127 "parameters": {}, | |
128 "path": "v2beta1/folders:search", | |
129 "request": { | |
130 "$ref": "SearchFoldersRequest" | |
131 }, | |
132 "response": { | |
133 "$ref": "SearchFoldersResponse" | |
134 }, | |
135 "scopes": [ | |
136 "https://www.googleapis.com/auth/cloud-platform", | |
137 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
138 ] | |
139 }, | |
140 "undelete": { | |
141 "description": "Cancels the deletion request for a Folder. T
his method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn
order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn additio
n, reintroducing the folder into the tree must not violate\nfolder naming, heigh
t and fanout constraints described in the\n[CreateFolder] documentation.\nThe ca
ller must have `resourcemanager.folders.undelete` permission on the\nidentified
folder.", | |
142 "httpMethod": "POST", | |
143 "id": "cloudresourcemanager.folders.undelete", | |
144 "parameterOrder": [ | |
145 "name" | |
146 ], | |
147 "parameters": { | |
148 "name": { | |
149 "description": "The resource name of the Folder to u
ndelete.\nMust be of the form `folders/{folder_id}`.", | |
150 "location": "path", | |
151 "pattern": "^folders/[^/]+$", | |
152 "required": true, | |
153 "type": "string" | |
154 } | |
155 }, | |
156 "path": "v2beta1/{+name}:undelete", | |
157 "request": { | |
158 "$ref": "UndeleteFolderRequest" | |
159 }, | |
160 "response": { | |
161 "$ref": "Folder" | |
162 }, | |
163 "scopes": [ | |
164 "https://www.googleapis.com/auth/cloud-platform" | |
165 ] | |
166 }, | |
167 "get": { | |
168 "description": "Retrieves a Folder identified by the supplie
d resource name.\nValid Folder resource names have the format `folders/{folder_i
d}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folde
rs.get` permission on the\nidentified folder.", | |
169 "httpMethod": "GET", | |
170 "id": "cloudresourcemanager.folders.get", | |
171 "parameterOrder": [ | |
172 "name" | |
173 ], | |
174 "parameters": { | |
175 "name": { | |
176 "description": "The resource name of the Folder to r
etrieve.\nMust be of the form `folders/{folder_id}`.", | |
177 "location": "path", | |
178 "pattern": "^folders/[^/]+$", | |
179 "required": true, | |
180 "type": "string" | |
181 } | |
182 }, | |
183 "path": "v2beta1/{+name}", | |
184 "response": { | |
185 "$ref": "Folder" | |
186 }, | |
187 "scopes": [ | |
188 "https://www.googleapis.com/auth/cloud-platform", | |
189 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
190 ] | |
191 }, | |
192 "patch": { | |
193 "description": "Updates a Folder, changing its display_name.
\nChanges to the folder display_name will be rejected if they violate either\nth
e display_name formatting rules or naming constraints described in\nthe [CreateF
older] documentation.\n+ The Folder's display name must start and end with a let
ter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and
can be\nno longer than 30 characters. This is captured by the regular expression
:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have
`resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf th
e update fails due to the unique name constraint then a\nPreconditionFailure exp
laining this violation will be returned\nin the Status.details field.", | |
194 "httpMethod": "PATCH", | |
195 "id": "cloudresourcemanager.folders.patch", | |
196 "parameterOrder": [ | |
197 "name" | |
198 ], | |
199 "parameters": { | |
200 "updateMask": { | |
201 "description": "Fields to be updated.\nOnly the `dis
play_name` can be updated.", | |
202 "format": "google-fieldmask", | |
203 "location": "query", | |
204 "type": "string" | |
205 }, | |
206 "name": { | |
207 "description": "Output only. The resource name of th
e Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", | |
208 "location": "path", | |
209 "pattern": "^folders/[^/]+$", | |
210 "required": true, | |
211 "type": "string" | |
212 } | |
213 }, | |
214 "path": "v2beta1/{+name}", | |
215 "request": { | |
216 "$ref": "Folder" | |
217 }, | |
218 "response": { | |
219 "$ref": "Folder" | |
220 }, | |
221 "scopes": [ | |
222 "https://www.googleapis.com/auth/cloud-platform" | |
223 ] | |
224 }, | |
225 "move": { | |
226 "description": "Moves a Folder under a new resource parent.\
nReturns an Operation which can be used to track the progress of the\nfolder mov
e workflow.\nUpon success the Operation.response field will be populated with th
e\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure
cause will\nbe returned - if the failure occurs synchronously then the\nFolderOp
erationError will be returned via the Status.details field\nand if it occurs asy
nchronously then the FolderOperation will be returned\nvia the the Operation.err
or field.\nIn addition, the Operation.metadata field will be populated with a\nF
olderOperation message as an aid to stateless clients.\nFolder moves will be rej
ected if they violate either the naming, height\nor fanout constraints described
in the [CreateFolder] documentation.\nThe caller must have `resourcemanager.fol
ders.move` permission on the\nfolder's current and proposed new parent.", | |
227 "httpMethod": "POST", | |
228 "id": "cloudresourcemanager.folders.move", | |
229 "parameterOrder": [ | |
230 "name" | |
231 ], | |
232 "parameters": { | |
233 "name": { | |
234 "description": "The resource name of the Folder to m
ove.\nMust be of the form folders/{folder_id}", | |
235 "location": "path", | |
236 "pattern": "^folders/[^/]+$", | |
237 "required": true, | |
238 "type": "string" | |
239 } | |
240 }, | |
241 "path": "v2beta1/{+name}:move", | |
242 "request": { | |
243 "$ref": "MoveFolderRequest" | |
244 }, | |
245 "response": { | |
246 "$ref": "Operation" | |
247 }, | |
248 "scopes": [ | |
249 "https://www.googleapis.com/auth/cloud-platform" | |
250 ] | |
251 }, | |
252 "testIamPermissions": { | 122 "testIamPermissions": { |
253 "description": "Returns permissions that a caller has on the
specified Folder.\nThe `resource` field should be the Folder's resource name,\n
e.g. \"folders/1234\".\n\nThere are no permissions required for making this API
call.", | 123 "description": "Returns permissions that a caller has on the
specified Folder.\nThe `resource` field should be the Folder's resource name,\n
e.g. \"folders/1234\".\n\nThere are no permissions required for making this API
call.", |
254 "httpMethod": "POST", | 124 "httpMethod": "POST", |
255 "id": "cloudresourcemanager.folders.testIamPermissions", | 125 "id": "cloudresourcemanager.folders.testIamPermissions", |
256 "parameterOrder": [ | 126 "parameterOrder": [ |
257 "resource" | 127 "resource" |
258 ], | 128 ], |
259 "parameters": { | 129 "parameters": { |
260 "resource": { | 130 "resource": { |
261 "description": "REQUIRED: The resource for which the
policy detail is being requested.\nSee the operation documentation for the appr
opriate value for this field.", | 131 "description": "REQUIRED: The resource for which the
policy detail is being requested.\nSee the operation documentation for the appr
opriate value for this field.", |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
299 "scopes": [ | 169 "scopes": [ |
300 "https://www.googleapis.com/auth/cloud-platform" | 170 "https://www.googleapis.com/auth/cloud-platform" |
301 ] | 171 ] |
302 }, | 172 }, |
303 "list": { | 173 "list": { |
304 "description": "Lists the Folders that are direct descendant
s of supplied parent resource.\nList provides a strongly consistent view of the
Folders underneath\nthe specified parent resource.\nList returns Folders sorted
based upon the (ascending) lexical ordering\nof their display_name.\nThe caller
must have `resourcemanager.folders.list` permission on the\nidentified parent.", | 174 "description": "Lists the Folders that are direct descendant
s of supplied parent resource.\nList provides a strongly consistent view of the
Folders underneath\nthe specified parent resource.\nList returns Folders sorted
based upon the (ascending) lexical ordering\nof their display_name.\nThe caller
must have `resourcemanager.folders.list` permission on the\nidentified parent.", |
305 "httpMethod": "GET", | 175 "httpMethod": "GET", |
306 "id": "cloudresourcemanager.folders.list", | 176 "id": "cloudresourcemanager.folders.list", |
307 "parameterOrder": [], | 177 "parameterOrder": [], |
308 "parameters": { | 178 "parameters": { |
309 "showDeleted": { | |
310 "description": "Controls whether Folders in the [DEL
ETE_REQUESTED} state should\nbe returned.", | |
311 "location": "query", | |
312 "type": "boolean" | |
313 }, | |
314 "pageToken": { | |
315 "description": "A pagination token returned from a p
revious call to `ListFolders`\nthat indicates where this listing should continue
from.\nThis field is optional.", | |
316 "location": "query", | |
317 "type": "string" | |
318 }, | |
319 "pageSize": { | 179 "pageSize": { |
320 "description": "The maximum number of Folders to ret
urn in the response.\nThis field is optional.", | 180 "description": "The maximum number of Folders to ret
urn in the response.\nThis field is optional.", |
321 "format": "int32", | 181 "format": "int32", |
322 "location": "query", | 182 "location": "query", |
323 "type": "integer" | 183 "type": "integer" |
324 }, | 184 }, |
325 "parent": { | 185 "parent": { |
326 "description": "The resource name of the Organizatio
n or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{fold
er_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by che
cking the\n`resourcemanager.folders.list` permission on the `parent`.", | 186 "description": "The resource name of the Organizatio
n or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{fold
er_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by che
cking the\n`resourcemanager.folders.list` permission on the `parent`.", |
327 "location": "query", | 187 "location": "query", |
328 "type": "string" | 188 "type": "string" |
| 189 }, |
| 190 "showDeleted": { |
| 191 "description": "Controls whether Folders in the [DEL
ETE_REQUESTED} state should\nbe returned.", |
| 192 "location": "query", |
| 193 "type": "boolean" |
| 194 }, |
| 195 "pageToken": { |
| 196 "description": "A pagination token returned from a p
revious call to `ListFolders`\nthat indicates where this listing should continue
from.\nThis field is optional.", |
| 197 "location": "query", |
| 198 "type": "string" |
329 } | 199 } |
330 }, | 200 }, |
331 "path": "v2beta1/folders", | 201 "path": "v2beta1/folders", |
332 "response": { | 202 "response": { |
333 "$ref": "ListFoldersResponse" | 203 "$ref": "ListFoldersResponse" |
334 }, | 204 }, |
335 "scopes": [ | 205 "scopes": [ |
336 "https://www.googleapis.com/auth/cloud-platform", | 206 "https://www.googleapis.com/auth/cloud-platform", |
337 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 207 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
338 ] | 208 ] |
339 }, | 209 }, |
| 210 "setIamPolicy": { |
| 211 "description": "Sets the access control policy on a Folder,
replacing any existing policy.\nThe `resource` field should be the Folder's reso
urce name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folder
s.setIamPolicy` permission\non the identified folder.", |
| 212 "httpMethod": "POST", |
| 213 "id": "cloudresourcemanager.folders.setIamPolicy", |
| 214 "parameterOrder": [ |
| 215 "resource" |
| 216 ], |
| 217 "parameters": { |
| 218 "resource": { |
| 219 "description": "REQUIRED: The resource for which the
policy is being specified.\nSee the operation documentation for the appropriate
value for this field.", |
| 220 "location": "path", |
| 221 "pattern": "^folders/[^/]+$", |
| 222 "required": true, |
| 223 "type": "string" |
| 224 } |
| 225 }, |
| 226 "path": "v2beta1/{+resource}:setIamPolicy", |
| 227 "request": { |
| 228 "$ref": "SetIamPolicyRequest" |
| 229 }, |
| 230 "response": { |
| 231 "$ref": "Policy" |
| 232 }, |
| 233 "scopes": [ |
| 234 "https://www.googleapis.com/auth/cloud-platform" |
| 235 ] |
| 236 }, |
340 "create": { | 237 "create": { |
341 "description": "Creates a Folder in the resource hierarchy.\
nReturns an Operation which can be used to track the progress of the\nfolder cre
ation workflow.\nUpon success the Operation.response field will be populated wit
h the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder m
ust not violate\nthe Folder naming, height or fanout constraints.\n+ The Folder'
s display_name must be distinct from all other Folder's that\nshare its parent.\
n+ The addition of the Folder must not cause the active Folder hierarchy\nto exc
eed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed
to reach a height of 8; this provides additional headroom when\nmoving folders t
hat contain deleted folders.\n+ The addition of the Folder must not cause the to
tal number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails
due to a folder constraint violation,\na PreconditionFailure explaining the vio
lation will be returned.\nIf the failure occurs synchronously then the Precondit
ionFailure\nwill be returned via the Status.details field and if it occurs\nasyn
chronously then the PreconditionFailure will be returned\nvia the the Operation.
error field.\n\nThe caller must have `resourcemanager.folders.create` permission
on the\nidentified parent.", | 238 "description": "Creates a Folder in the resource hierarchy.\
nReturns an Operation which can be used to track the progress of the\nfolder cre
ation workflow.\nUpon success the Operation.response field will be populated wit
h the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder m
ust not violate\nthe Folder naming, height or fanout constraints.\n+ The Folder'
s display_name must be distinct from all other Folder's that\nshare its parent.\
n+ The addition of the Folder must not cause the active Folder hierarchy\nto exc
eed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed
to reach a height of 8; this provides additional headroom when\nmoving folders t
hat contain deleted folders.\n+ The addition of the Folder must not cause the to
tal number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails
due to a folder constraint violation,\na PreconditionFailure explaining the vio
lation will be returned.\nIf the failure occurs synchronously then the Precondit
ionFailure\nwill be returned via the Status.details field and if it occurs\nasyn
chronously then the PreconditionFailure will be returned\nvia the the Operation.
error field.\n\nThe caller must have `resourcemanager.folders.create` permission
on the\nidentified parent.", |
342 "httpMethod": "POST", | 239 "httpMethod": "POST", |
343 "id": "cloudresourcemanager.folders.create", | 240 "id": "cloudresourcemanager.folders.create", |
344 "parameterOrder": [], | 241 "parameterOrder": [], |
345 "parameters": { | 242 "parameters": { |
346 "parent": { | 243 "parent": { |
347 "description": "The resource name of the new Folder'
s parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`
.", | 244 "description": "The resource name of the new Folder'
s parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`
.", |
348 "location": "query", | 245 "location": "query", |
349 "type": "string" | 246 "type": "string" |
350 } | 247 } |
351 }, | 248 }, |
352 "path": "v2beta1/folders", | 249 "path": "v2beta1/folders", |
353 "request": { | 250 "request": { |
354 "$ref": "Folder" | 251 "$ref": "Folder" |
355 }, | 252 }, |
356 "response": { | 253 "response": { |
357 "$ref": "Operation" | 254 "$ref": "Operation" |
358 }, | 255 }, |
359 "scopes": [ | 256 "scopes": [ |
360 "https://www.googleapis.com/auth/cloud-platform" | 257 "https://www.googleapis.com/auth/cloud-platform" |
361 ] | 258 ] |
362 }, | 259 }, |
363 "setIamPolicy": { | |
364 "description": "Sets the access control policy on a Folder,
replacing any existing policy.\nThe `resource` field should be the Folder's reso
urce name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folder
s.setIamPolicy` permission\non the identified folder.", | |
365 "httpMethod": "POST", | |
366 "id": "cloudresourcemanager.folders.setIamPolicy", | |
367 "parameterOrder": [ | |
368 "resource" | |
369 ], | |
370 "parameters": { | |
371 "resource": { | |
372 "description": "REQUIRED: The resource for which the
policy is being specified.\nSee the operation documentation for the appropriate
value for this field.", | |
373 "location": "path", | |
374 "pattern": "^folders/[^/]+$", | |
375 "required": true, | |
376 "type": "string" | |
377 } | |
378 }, | |
379 "path": "v2beta1/{+resource}:setIamPolicy", | |
380 "request": { | |
381 "$ref": "SetIamPolicyRequest" | |
382 }, | |
383 "response": { | |
384 "$ref": "Policy" | |
385 }, | |
386 "scopes": [ | |
387 "https://www.googleapis.com/auth/cloud-platform" | |
388 ] | |
389 }, | |
390 "getIamPolicy": { | 260 "getIamPolicy": { |
391 "description": "Gets the access control policy for a Folder.
The returned policy may be\nempty if no such policy or resource exists. The `re
source` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe
caller must have `resourcemanager.folders.getIamPolicy` permission\non the iden
tified folder.", | 261 "description": "Gets the access control policy for a Folder.
The returned policy may be\nempty if no such policy or resource exists. The `re
source` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe
caller must have `resourcemanager.folders.getIamPolicy` permission\non the iden
tified folder.", |
392 "httpMethod": "POST", | 262 "httpMethod": "POST", |
393 "id": "cloudresourcemanager.folders.getIamPolicy", | 263 "id": "cloudresourcemanager.folders.getIamPolicy", |
394 "parameterOrder": [ | 264 "parameterOrder": [ |
395 "resource" | 265 "resource" |
396 ], | 266 ], |
397 "parameters": { | 267 "parameters": { |
398 "resource": { | 268 "resource": { |
399 "description": "REQUIRED: The resource for which the
policy is being requested.\nSee the operation documentation for the appropriate
value for this field.", | 269 "description": "REQUIRED: The resource for which the
policy is being requested.\nSee the operation documentation for the appropriate
value for this field.", |
400 "location": "path", | 270 "location": "path", |
401 "pattern": "^folders/[^/]+$", | 271 "pattern": "^folders/[^/]+$", |
402 "required": true, | 272 "required": true, |
403 "type": "string" | 273 "type": "string" |
404 } | 274 } |
405 }, | 275 }, |
406 "path": "v2beta1/{+resource}:getIamPolicy", | 276 "path": "v2beta1/{+resource}:getIamPolicy", |
407 "request": { | 277 "request": { |
408 "$ref": "GetIamPolicyRequest" | 278 "$ref": "GetIamPolicyRequest" |
409 }, | 279 }, |
410 "response": { | 280 "response": { |
411 "$ref": "Policy" | 281 "$ref": "Policy" |
412 }, | 282 }, |
413 "scopes": [ | 283 "scopes": [ |
414 "https://www.googleapis.com/auth/cloud-platform", | 284 "https://www.googleapis.com/auth/cloud-platform", |
415 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 285 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
416 ] | 286 ] |
| 287 }, |
| 288 "search": { |
| 289 "description": "Search for folders that match specific filte
r criteria.\nSearch provides an eventually consistent view of the folders a user
has\naccess to which meet the specified filter criteria.\n\nThis will only retu
rn folders on which the caller has the\npermission `resourcemanager.folders.get`
.", |
| 290 "httpMethod": "POST", |
| 291 "id": "cloudresourcemanager.folders.search", |
| 292 "parameterOrder": [], |
| 293 "parameters": {}, |
| 294 "path": "v2beta1/folders:search", |
| 295 "request": { |
| 296 "$ref": "SearchFoldersRequest" |
| 297 }, |
| 298 "response": { |
| 299 "$ref": "SearchFoldersResponse" |
| 300 }, |
| 301 "scopes": [ |
| 302 "https://www.googleapis.com/auth/cloud-platform", |
| 303 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 304 ] |
| 305 }, |
| 306 "undelete": { |
| 307 "description": "Cancels the deletion request for a Folder. T
his method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn
order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn additio
n, reintroducing the folder into the tree must not violate\nfolder naming, heigh
t and fanout constraints described in the\n[CreateFolder] documentation.\nThe ca
ller must have `resourcemanager.folders.undelete` permission on the\nidentified
folder.", |
| 308 "httpMethod": "POST", |
| 309 "id": "cloudresourcemanager.folders.undelete", |
| 310 "parameterOrder": [ |
| 311 "name" |
| 312 ], |
| 313 "parameters": { |
| 314 "name": { |
| 315 "description": "The resource name of the Folder to u
ndelete.\nMust be of the form `folders/{folder_id}`.", |
| 316 "location": "path", |
| 317 "pattern": "^folders/[^/]+$", |
| 318 "required": true, |
| 319 "type": "string" |
| 320 } |
| 321 }, |
| 322 "path": "v2beta1/{+name}:undelete", |
| 323 "request": { |
| 324 "$ref": "UndeleteFolderRequest" |
| 325 }, |
| 326 "response": { |
| 327 "$ref": "Folder" |
| 328 }, |
| 329 "scopes": [ |
| 330 "https://www.googleapis.com/auth/cloud-platform" |
| 331 ] |
| 332 }, |
| 333 "get": { |
| 334 "description": "Retrieves a Folder identified by the supplie
d resource name.\nValid Folder resource names have the format `folders/{folder_i
d}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folde
rs.get` permission on the\nidentified folder.", |
| 335 "httpMethod": "GET", |
| 336 "id": "cloudresourcemanager.folders.get", |
| 337 "parameterOrder": [ |
| 338 "name" |
| 339 ], |
| 340 "parameters": { |
| 341 "name": { |
| 342 "description": "The resource name of the Folder to r
etrieve.\nMust be of the form `folders/{folder_id}`.", |
| 343 "location": "path", |
| 344 "pattern": "^folders/[^/]+$", |
| 345 "required": true, |
| 346 "type": "string" |
| 347 } |
| 348 }, |
| 349 "path": "v2beta1/{+name}", |
| 350 "response": { |
| 351 "$ref": "Folder" |
| 352 }, |
| 353 "scopes": [ |
| 354 "https://www.googleapis.com/auth/cloud-platform", |
| 355 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 356 ] |
| 357 }, |
| 358 "patch": { |
| 359 "description": "Updates a Folder, changing its display_name.
\nChanges to the folder display_name will be rejected if they violate either\nth
e display_name formatting rules or naming constraints described in\nthe [CreateF
older] documentation.\n+ The Folder's display name must start and end with a let
ter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and
can be\nno longer than 30 characters. This is captured by the regular expression
:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have
`resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf th
e update fails due to the unique name constraint then a\nPreconditionFailure exp
laining this violation will be returned\nin the Status.details field.", |
| 360 "httpMethod": "PATCH", |
| 361 "id": "cloudresourcemanager.folders.patch", |
| 362 "parameterOrder": [ |
| 363 "name" |
| 364 ], |
| 365 "parameters": { |
| 366 "updateMask": { |
| 367 "description": "Fields to be updated.\nOnly the `dis
play_name` can be updated.", |
| 368 "format": "google-fieldmask", |
| 369 "location": "query", |
| 370 "type": "string" |
| 371 }, |
| 372 "name": { |
| 373 "description": "Output only. The resource name of th
e Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", |
| 374 "location": "path", |
| 375 "pattern": "^folders/[^/]+$", |
| 376 "required": true, |
| 377 "type": "string" |
| 378 } |
| 379 }, |
| 380 "path": "v2beta1/{+name}", |
| 381 "request": { |
| 382 "$ref": "Folder" |
| 383 }, |
| 384 "response": { |
| 385 "$ref": "Folder" |
| 386 }, |
| 387 "scopes": [ |
| 388 "https://www.googleapis.com/auth/cloud-platform" |
| 389 ] |
| 390 }, |
| 391 "move": { |
| 392 "description": "Moves a Folder under a new resource parent.\
nReturns an Operation which can be used to track the progress of the\nfolder mov
e workflow.\nUpon success the Operation.response field will be populated with th
e\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure
cause will\nbe returned - if the failure occurs synchronously then the\nFolderOp
erationError will be returned via the Status.details field\nand if it occurs asy
nchronously then the FolderOperation will be returned\nvia the the Operation.err
or field.\nIn addition, the Operation.metadata field will be populated with a\nF
olderOperation message as an aid to stateless clients.\nFolder moves will be rej
ected if they violate either the naming, height\nor fanout constraints described
in the [CreateFolder] documentation.\nThe caller must have `resourcemanager.fol
ders.move` permission on the\nfolder's current and proposed new parent.", |
| 393 "httpMethod": "POST", |
| 394 "id": "cloudresourcemanager.folders.move", |
| 395 "parameterOrder": [ |
| 396 "name" |
| 397 ], |
| 398 "parameters": { |
| 399 "name": { |
| 400 "description": "The resource name of the Folder to m
ove.\nMust be of the form folders/{folder_id}", |
| 401 "location": "path", |
| 402 "pattern": "^folders/[^/]+$", |
| 403 "required": true, |
| 404 "type": "string" |
| 405 } |
| 406 }, |
| 407 "path": "v2beta1/{+name}:move", |
| 408 "request": { |
| 409 "$ref": "MoveFolderRequest" |
| 410 }, |
| 411 "response": { |
| 412 "$ref": "Operation" |
| 413 }, |
| 414 "scopes": [ |
| 415 "https://www.googleapis.com/auth/cloud-platform" |
| 416 ] |
417 } | 417 } |
418 } | 418 } |
419 } | 419 } |
420 }, | 420 }, |
421 "revision": "20170814", | 421 "revision": "20170830", |
422 "rootUrl": "https://cloudresourcemanager.googleapis.com/", | 422 "rootUrl": "https://cloudresourcemanager.googleapis.com/", |
423 "schemas": { | 423 "schemas": { |
424 "FolderOperationError": { | |
425 "description": "A classification of the Folder Operation error.", | |
426 "id": "FolderOperationError", | |
427 "properties": { | |
428 "errorMessageId": { | |
429 "description": "The type of operation error experienced.", | |
430 "enum": [ | |
431 "ERROR_TYPE_UNSPECIFIED", | |
432 "ACTIVE_FOLDER_HEIGHT_VIOLATION", | |
433 "MAX_CHILD_FOLDERS_VIOLATION", | |
434 "FOLDER_NAME_UNIQUENESS_VIOLATION", | |
435 "RESOURCE_DELETED_VIOLATION", | |
436 "PARENT_DELETED_VIOLATION", | |
437 "CYCLE_INTRODUCED_VIOLATION", | |
438 "FOLDER_BEING_MOVED_VIOLATION", | |
439 "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", | |
440 "DELETED_FOLDER_HEIGHT_VIOLATION" | |
441 ], | |
442 "enumDescriptions": [ | |
443 "The error type was unrecognized or unspecified.", | |
444 "The attempted action would violate the max folder depth
constraint.", | |
445 "The attempted action would violate the max child folder
s constraint.", | |
446 "The attempted action would violate the locally-unique f
older\ndisplay_name constraint.", | |
447 "The resource being moved has been deleted.", | |
448 "The resource a folder was being added to has been delet
ed.", | |
449 "The attempted action would introduce cycle in resource
path.", | |
450 "The attempted action would move a folder that is alread
y being moved.", | |
451 "The folder the caller is trying to delete contains acti
ve resources.", | |
452 "The attempted action would violate the max deleted fold
er depth\nconstraint." | |
453 ], | |
454 "type": "string" | |
455 } | |
456 }, | |
457 "type": "object" | |
458 }, | |
459 "FolderOperation": { | |
460 "description": "Metadata describing a long running folder operation"
, | |
461 "id": "FolderOperation", | |
462 "properties": { | |
463 "sourceParent": { | |
464 "description": "The resource name of the folder's parent.\nO
nly applicable when the operation_type is MOVE.", | |
465 "type": "string" | |
466 }, | |
467 "displayName": { | |
468 "description": "The display name of the folder.", | |
469 "type": "string" | |
470 }, | |
471 "destinationParent": { | |
472 "description": "The resource name of the folder or organizat
ion we are either creating\nthe folder under or moving the folder to.", | |
473 "type": "string" | |
474 }, | |
475 "operationType": { | |
476 "description": "The type of this operation.", | |
477 "enum": [ | |
478 "OPERATION_TYPE_UNSPECIFIED", | |
479 "CREATE", | |
480 "MOVE" | |
481 ], | |
482 "enumDescriptions": [ | |
483 "Operation type not specified.", | |
484 "A create folder operation.", | |
485 "A move folder operation." | |
486 ], | |
487 "type": "string" | |
488 } | |
489 }, | |
490 "type": "object" | |
491 }, | |
492 "Policy": { | |
493 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", | |
494 "id": "Policy", | |
495 "properties": { | |
496 "etag": { | |
497 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", | |
498 "format": "byte", | |
499 "type": "string" | |
500 }, | |
501 "version": { | |
502 "description": "Version of the `Policy`. The default version
is 0.", | |
503 "format": "int32", | |
504 "type": "integer" | |
505 }, | |
506 "auditConfigs": { | |
507 "description": "Specifies cloud audit logging configuration
for this policy.", | |
508 "items": { | |
509 "$ref": "AuditConfig" | |
510 }, | |
511 "type": "array" | |
512 }, | |
513 "bindings": { | |
514 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", | |
515 "items": { | |
516 "$ref": "Binding" | |
517 }, | |
518 "type": "array" | |
519 } | |
520 }, | |
521 "type": "object" | |
522 }, | |
523 "AuditConfig": { | |
524 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", | |
525 "id": "AuditConfig", | |
526 "properties": { | |
527 "auditLogConfigs": { | |
528 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", | |
529 "items": { | |
530 "$ref": "AuditLogConfig" | |
531 }, | |
532 "type": "array" | |
533 }, | |
534 "service": { | |
535 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", | |
536 "type": "string" | |
537 } | |
538 }, | |
539 "type": "object" | |
540 }, | |
541 "Operation": { | |
542 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | |
543 "id": "Operation", | |
544 "properties": { | |
545 "done": { | |
546 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", | |
547 "type": "boolean" | |
548 }, | |
549 "response": { | |
550 "additionalProperties": { | |
551 "description": "Properties of the object. Contains field
@type with type URL.", | |
552 "type": "any" | |
553 }, | |
554 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", | |
555 "type": "object" | |
556 }, | |
557 "name": { | |
558 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", | |
559 "type": "string" | |
560 }, | |
561 "error": { | |
562 "$ref": "Status", | |
563 "description": "The error result of the operation in case of
failure or cancellation." | |
564 }, | |
565 "metadata": { | |
566 "additionalProperties": { | |
567 "description": "Properties of the object. Contains field
@type with type URL.", | |
568 "type": "any" | |
569 }, | |
570 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", | |
571 "type": "object" | |
572 } | |
573 }, | |
574 "type": "object" | |
575 }, | |
576 "ListFoldersResponse": { | 424 "ListFoldersResponse": { |
577 "description": "The ListFolders response message.", | 425 "description": "The ListFolders response message.", |
578 "id": "ListFoldersResponse", | 426 "id": "ListFoldersResponse", |
579 "properties": { | 427 "properties": { |
| 428 "nextPageToken": { |
| 429 "description": "A pagination token returned from a previous
call to `ListFolders`\nthat indicates from where listing should continue.\nThis
field is optional.", |
| 430 "type": "string" |
| 431 }, |
580 "folders": { | 432 "folders": { |
581 "description": "A possibly paginated list of Folders that ar
e direct descendants of\nthe specified parent resource.", | 433 "description": "A possibly paginated list of Folders that ar
e direct descendants of\nthe specified parent resource.", |
582 "items": { | 434 "items": { |
583 "$ref": "Folder" | 435 "$ref": "Folder" |
584 }, | 436 }, |
585 "type": "array" | 437 "type": "array" |
586 }, | |
587 "nextPageToken": { | |
588 "description": "A pagination token returned from a previous
call to `ListFolders`\nthat indicates from where listing should continue.\nThis
field is optional.", | |
589 "type": "string" | |
590 } | 438 } |
591 }, | 439 }, |
592 "type": "object" | 440 "type": "object" |
593 }, | 441 }, |
594 "MoveFolderRequest": { | 442 "MoveFolderRequest": { |
595 "description": "The MoveFolder request message.", | 443 "description": "The MoveFolder request message.", |
596 "id": "MoveFolderRequest", | 444 "id": "MoveFolderRequest", |
597 "properties": { | 445 "properties": { |
598 "destinationParent": { | 446 "destinationParent": { |
599 "description": "The resource name of the Folder or Organizat
ion to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or
`organizations/{org_id}`.", | 447 "description": "The resource name of the Folder or Organizat
ion to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or
`organizations/{org_id}`.", |
600 "type": "string" | 448 "type": "string" |
601 } | 449 } |
602 }, | 450 }, |
603 "type": "object" | 451 "type": "object" |
604 }, | 452 }, |
605 "SetIamPolicyRequest": { | 453 "SetIamPolicyRequest": { |
606 "description": "Request message for `SetIamPolicy` method.", | 454 "description": "Request message for `SetIamPolicy` method.", |
607 "id": "SetIamPolicyRequest", | 455 "id": "SetIamPolicyRequest", |
608 "properties": { | 456 "properties": { |
609 "policy": { | |
610 "$ref": "Policy", | |
611 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." | |
612 }, | |
613 "updateMask": { | 457 "updateMask": { |
614 "description": "OPTIONAL: A FieldMask specifying which field
s of the policy to modify. Only\nthe fields in the mask will be modified. If no
mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\
"\nThis field is only used by Cloud IAM.", | 458 "description": "OPTIONAL: A FieldMask specifying which field
s of the policy to modify. Only\nthe fields in the mask will be modified. If no
mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\
"\nThis field is only used by Cloud IAM.", |
615 "format": "google-fieldmask", | 459 "format": "google-fieldmask", |
616 "type": "string" | 460 "type": "string" |
| 461 }, |
| 462 "policy": { |
| 463 "$ref": "Policy", |
| 464 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." |
617 } | 465 } |
618 }, | 466 }, |
619 "type": "object" | 467 "type": "object" |
620 }, | 468 }, |
621 "SearchFoldersResponse": { | 469 "SearchFoldersResponse": { |
622 "description": "The response message for searching folders.", | 470 "description": "The response message for searching folders.", |
623 "id": "SearchFoldersResponse", | 471 "id": "SearchFoldersResponse", |
624 "properties": { | 472 "properties": { |
625 "nextPageToken": { | 473 "nextPageToken": { |
626 "description": "A pagination token returned from a previous
call to `SearchFolders`\nthat indicates from where searching should continue.\nT
his field is optional.", | 474 "description": "A pagination token returned from a previous
call to `SearchFolders`\nthat indicates from where searching should continue.\nT
his field is optional.", |
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
698 "description": "Search criteria used to select the Folders t
o return.\nIf no search criteria is specified then all accessible folders will b
e\nreturned.\n\nQuery expressions can be used to restrict results based upon dis
playName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and
`OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example que
ries are:\n|Query|Description|\n|------|-----------|\n|displayName=Test*|Folders
whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose
lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folde
rs/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose\n
parent is \"folders/123\".|", | 546 "description": "Search criteria used to select the Folders t
o return.\nIf no search criteria is specified then all accessible folders will b
e\nreturned.\n\nQuery expressions can be used to restrict results based upon dis
playName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and
`OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example que
ries are:\n|Query|Description|\n|------|-----------|\n|displayName=Test*|Folders
whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose
lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folde
rs/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose\n
parent is \"folders/123\".|", |
699 "type": "string" | 547 "type": "string" |
700 } | 548 } |
701 }, | 549 }, |
702 "type": "object" | 550 "type": "object" |
703 }, | 551 }, |
704 "Folder": { | 552 "Folder": { |
705 "description": "A Folder in an Organization's resource hierarchy, us
ed to\norganize that Organization's resources.", | 553 "description": "A Folder in an Organization's resource hierarchy, us
ed to\norganize that Organization's resources.", |
706 "id": "Folder", | 554 "id": "Folder", |
707 "properties": { | 555 "properties": { |
708 "displayName": { | |
709 "description": "The folder’s display name.\nA folder’s displ
ay name must be unique amongst its siblings, e.g.\nno two folders with the same
parent can share the same display name.\nThe display name must start and end wit
h a letter or digit, may contain\nletters, digits, spaces, hyphens and underscor
es and can be no longer\nthan 30 characters. This is captured by the regular exp
ression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.", | |
710 "type": "string" | |
711 }, | |
712 "parent": { | |
713 "description": "The Folder’s parent's resource name.\nUpdate
s to the folder's parent must be performed via [MoveFolders].", | |
714 "type": "string" | |
715 }, | |
716 "createTime": { | 556 "createTime": { |
717 "description": "Output only. Timestamp when the Folder was c
reated. Assigned by the server.", | 557 "description": "Output only. Timestamp when the Folder was c
reated. Assigned by the server.", |
718 "format": "google-datetime", | 558 "format": "google-datetime", |
719 "type": "string" | 559 "type": "string" |
720 }, | 560 }, |
721 "lifecycleState": { | 561 "lifecycleState": { |
722 "description": "Output only. The lifecycle state of the fol
der.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [
UndeleteFolder].", | 562 "description": "Output only. The lifecycle state of the fol
der.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [
UndeleteFolder].", |
723 "enum": [ | 563 "enum": [ |
724 "LIFECYCLE_STATE_UNSPECIFIED", | 564 "LIFECYCLE_STATE_UNSPECIFIED", |
725 "ACTIVE", | 565 "ACTIVE", |
726 "DELETE_REQUESTED" | 566 "DELETE_REQUESTED" |
727 ], | 567 ], |
728 "enumDescriptions": [ | 568 "enumDescriptions": [ |
729 "Unspecified state.", | 569 "Unspecified state.", |
730 "The normal and active state.", | 570 "The normal and active state.", |
731 "The folder has been marked for deletion by the user." | 571 "The folder has been marked for deletion by the user." |
732 ], | 572 ], |
733 "type": "string" | 573 "type": "string" |
734 }, | 574 }, |
735 "name": { | 575 "name": { |
736 "description": "Output only. The resource name of the Folder
.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", | 576 "description": "Output only. The resource name of the Folder
.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", |
737 "type": "string" | 577 "type": "string" |
| 578 }, |
| 579 "displayName": { |
| 580 "description": "The folder’s display name.\nA folder’s displ
ay name must be unique amongst its siblings, e.g.\nno two folders with the same
parent can share the same display name.\nThe display name must start and end wit
h a letter or digit, may contain\nletters, digits, spaces, hyphens and underscor
es and can be no longer\nthan 30 characters. This is captured by the regular exp
ression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.", |
| 581 "type": "string" |
| 582 }, |
| 583 "parent": { |
| 584 "description": "The Folder’s parent's resource name.\nUpdate
s to the folder's parent must be performed via [MoveFolders].", |
| 585 "type": "string" |
738 } | 586 } |
739 }, | 587 }, |
740 "type": "object" | 588 "type": "object" |
741 }, | 589 }, |
742 "ProjectCreationStatus": { | 590 "ProjectCreationStatus": { |
743 "description": "A status object which is used as the `metadata` fiel
d for the Operation\nreturned by CreateProject. It provides insight for when sig
nificant phases of\nProject creation have completed.", | 591 "description": "A status object which is used as the `metadata` fiel
d for the Operation\nreturned by CreateProject. It provides insight for when sig
nificant phases of\nProject creation have completed.", |
744 "id": "ProjectCreationStatus", | 592 "id": "ProjectCreationStatus", |
745 "properties": { | 593 "properties": { |
| 594 "ready": { |
| 595 "description": "True if the project creation process is comp
lete.", |
| 596 "type": "boolean" |
| 597 }, |
746 "gettable": { | 598 "gettable": { |
747 "description": "True if the project can be retrieved using G
etProject. No other operations\non the project are guaranteed to work until the
project creation is\ncomplete.", | 599 "description": "True if the project can be retrieved using G
etProject. No other operations\non the project are guaranteed to work until the
project creation is\ncomplete.", |
748 "type": "boolean" | 600 "type": "boolean" |
749 }, | 601 }, |
750 "createTime": { | 602 "createTime": { |
751 "description": "Creation time of the project creation workfl
ow.", | 603 "description": "Creation time of the project creation workfl
ow.", |
752 "format": "google-datetime", | 604 "format": "google-datetime", |
753 "type": "string" | 605 "type": "string" |
754 }, | |
755 "ready": { | |
756 "description": "True if the project creation process is comp
lete.", | |
757 "type": "boolean" | |
758 } | 606 } |
759 }, | 607 }, |
760 "type": "object" | 608 "type": "object" |
761 }, | 609 }, |
| 610 "GetIamPolicyRequest": { |
| 611 "description": "Request message for `GetIamPolicy` method.", |
| 612 "id": "GetIamPolicyRequest", |
| 613 "properties": {}, |
| 614 "type": "object" |
| 615 }, |
762 "TestIamPermissionsResponse": { | 616 "TestIamPermissionsResponse": { |
763 "description": "Response message for `TestIamPermissions` method.", | 617 "description": "Response message for `TestIamPermissions` method.", |
764 "id": "TestIamPermissionsResponse", | 618 "id": "TestIamPermissionsResponse", |
765 "properties": { | 619 "properties": { |
766 "permissions": { | 620 "permissions": { |
767 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | 621 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
768 "items": { | 622 "items": { |
769 "type": "string" | 623 "type": "string" |
770 }, | 624 }, |
771 "type": "array" | 625 "type": "array" |
772 } | 626 } |
773 }, | 627 }, |
774 "type": "object" | 628 "type": "object" |
775 }, | 629 }, |
776 "GetIamPolicyRequest": { | |
777 "description": "Request message for `GetIamPolicy` method.", | |
778 "id": "GetIamPolicyRequest", | |
779 "properties": {}, | |
780 "type": "object" | |
781 }, | |
782 "UndeleteFolderRequest": { | 630 "UndeleteFolderRequest": { |
783 "description": "The UndeleteFolder request message.", | 631 "description": "The UndeleteFolder request message.", |
784 "id": "UndeleteFolderRequest", | 632 "id": "UndeleteFolderRequest", |
785 "properties": {}, | 633 "properties": {}, |
786 "type": "object" | 634 "type": "object" |
787 }, | 635 }, |
788 "AuditLogConfig": { | 636 "AuditLogConfig": { |
789 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", | 637 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", |
790 "id": "AuditLogConfig", | 638 "id": "AuditLogConfig", |
791 "properties": { | 639 "properties": { |
792 "exemptedMembers": { | |
793 "description": "Specifies the identities that do not cause l
ogging for this type of\npermission.\nFollows the same format of Binding.members
.", | |
794 "items": { | |
795 "type": "string" | |
796 }, | |
797 "type": "array" | |
798 }, | |
799 "logType": { | 640 "logType": { |
800 "description": "The log type that this config enables.", | 641 "description": "The log type that this config enables.", |
801 "enum": [ | 642 "enum": [ |
802 "LOG_TYPE_UNSPECIFIED", | 643 "LOG_TYPE_UNSPECIFIED", |
803 "ADMIN_READ", | 644 "ADMIN_READ", |
804 "DATA_WRITE", | 645 "DATA_WRITE", |
805 "DATA_READ" | 646 "DATA_READ" |
806 ], | 647 ], |
807 "enumDescriptions": [ | 648 "enumDescriptions": [ |
808 "Default case. Should never be this.", | 649 "Default case. Should never be this.", |
809 "Admin reads. Example: CloudIAM getIamPolicy", | 650 "Admin reads. Example: CloudIAM getIamPolicy", |
810 "Data writes. Example: CloudSQL Users create", | 651 "Data writes. Example: CloudSQL Users create", |
811 "Data reads. Example: CloudSQL Users list" | 652 "Data reads. Example: CloudSQL Users list" |
812 ], | 653 ], |
813 "type": "string" | 654 "type": "string" |
| 655 }, |
| 656 "exemptedMembers": { |
| 657 "description": "Specifies the identities that do not cause l
ogging for this type of\npermission.\nFollows the same format of Binding.members
.", |
| 658 "items": { |
| 659 "type": "string" |
| 660 }, |
| 661 "type": "array" |
814 } | 662 } |
815 }, | 663 }, |
816 "type": "object" | 664 "type": "object" |
817 }, | 665 }, |
818 "TestIamPermissionsRequest": { | 666 "TestIamPermissionsRequest": { |
819 "description": "Request message for `TestIamPermissions` method.", | 667 "description": "Request message for `TestIamPermissions` method.", |
820 "id": "TestIamPermissionsRequest", | 668 "id": "TestIamPermissionsRequest", |
821 "properties": { | 669 "properties": { |
822 "permissions": { | 670 "permissions": { |
823 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", | 671 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", |
824 "items": { | 672 "items": { |
825 "type": "string" | 673 "type": "string" |
826 }, | 674 }, |
827 "type": "array" | 675 "type": "array" |
828 } | 676 } |
829 }, | 677 }, |
830 "type": "object" | 678 "type": "object" |
| 679 }, |
| 680 "Policy": { |
| 681 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", |
| 682 "id": "Policy", |
| 683 "properties": { |
| 684 "auditConfigs": { |
| 685 "description": "Specifies cloud audit logging configuration
for this policy.", |
| 686 "items": { |
| 687 "$ref": "AuditConfig" |
| 688 }, |
| 689 "type": "array" |
| 690 }, |
| 691 "bindings": { |
| 692 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
| 693 "items": { |
| 694 "$ref": "Binding" |
| 695 }, |
| 696 "type": "array" |
| 697 }, |
| 698 "etag": { |
| 699 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", |
| 700 "format": "byte", |
| 701 "type": "string" |
| 702 }, |
| 703 "version": { |
| 704 "description": "Version of the `Policy`. The default version
is 0.", |
| 705 "format": "int32", |
| 706 "type": "integer" |
| 707 } |
| 708 }, |
| 709 "type": "object" |
| 710 }, |
| 711 "FolderOperation": { |
| 712 "description": "Metadata describing a long running folder operation"
, |
| 713 "id": "FolderOperation", |
| 714 "properties": { |
| 715 "sourceParent": { |
| 716 "description": "The resource name of the folder's parent.\nO
nly applicable when the operation_type is MOVE.", |
| 717 "type": "string" |
| 718 }, |
| 719 "displayName": { |
| 720 "description": "The display name of the folder.", |
| 721 "type": "string" |
| 722 }, |
| 723 "destinationParent": { |
| 724 "description": "The resource name of the folder or organizat
ion we are either creating\nthe folder under or moving the folder to.", |
| 725 "type": "string" |
| 726 }, |
| 727 "operationType": { |
| 728 "description": "The type of this operation.", |
| 729 "enum": [ |
| 730 "OPERATION_TYPE_UNSPECIFIED", |
| 731 "CREATE", |
| 732 "MOVE" |
| 733 ], |
| 734 "enumDescriptions": [ |
| 735 "Operation type not specified.", |
| 736 "A create folder operation.", |
| 737 "A move folder operation." |
| 738 ], |
| 739 "type": "string" |
| 740 } |
| 741 }, |
| 742 "type": "object" |
| 743 }, |
| 744 "FolderOperationError": { |
| 745 "description": "A classification of the Folder Operation error.", |
| 746 "id": "FolderOperationError", |
| 747 "properties": { |
| 748 "errorMessageId": { |
| 749 "description": "The type of operation error experienced.", |
| 750 "enum": [ |
| 751 "ERROR_TYPE_UNSPECIFIED", |
| 752 "ACTIVE_FOLDER_HEIGHT_VIOLATION", |
| 753 "MAX_CHILD_FOLDERS_VIOLATION", |
| 754 "FOLDER_NAME_UNIQUENESS_VIOLATION", |
| 755 "RESOURCE_DELETED_VIOLATION", |
| 756 "PARENT_DELETED_VIOLATION", |
| 757 "CYCLE_INTRODUCED_VIOLATION", |
| 758 "FOLDER_BEING_MOVED_VIOLATION", |
| 759 "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", |
| 760 "DELETED_FOLDER_HEIGHT_VIOLATION" |
| 761 ], |
| 762 "enumDescriptions": [ |
| 763 "The error type was unrecognized or unspecified.", |
| 764 "The attempted action would violate the max folder depth
constraint.", |
| 765 "The attempted action would violate the max child folder
s constraint.", |
| 766 "The attempted action would violate the locally-unique f
older\ndisplay_name constraint.", |
| 767 "The resource being moved has been deleted.", |
| 768 "The resource a folder was being added to has been delet
ed.", |
| 769 "The attempted action would introduce cycle in resource
path.", |
| 770 "The attempted action would move a folder that is alread
y being moved.", |
| 771 "The folder the caller is trying to delete contains acti
ve resources.", |
| 772 "The attempted action would violate the max deleted fold
er depth\nconstraint." |
| 773 ], |
| 774 "type": "string" |
| 775 } |
| 776 }, |
| 777 "type": "object" |
| 778 }, |
| 779 "AuditConfig": { |
| 780 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", |
| 781 "id": "AuditConfig", |
| 782 "properties": { |
| 783 "service": { |
| 784 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", |
| 785 "type": "string" |
| 786 }, |
| 787 "auditLogConfigs": { |
| 788 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", |
| 789 "items": { |
| 790 "$ref": "AuditLogConfig" |
| 791 }, |
| 792 "type": "array" |
| 793 } |
| 794 }, |
| 795 "type": "object" |
| 796 }, |
| 797 "Operation": { |
| 798 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 799 "id": "Operation", |
| 800 "properties": { |
| 801 "done": { |
| 802 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf `true`, the operation is completed, and either `er
ror` or `response` is\navailable.", |
| 803 "type": "boolean" |
| 804 }, |
| 805 "response": { |
| 806 "additionalProperties": { |
| 807 "description": "Properties of the object. Contains field
@type with type URL.", |
| 808 "type": "any" |
| 809 }, |
| 810 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
| 811 "type": "object" |
| 812 }, |
| 813 "name": { |
| 814 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
| 815 "type": "string" |
| 816 }, |
| 817 "error": { |
| 818 "$ref": "Status", |
| 819 "description": "The error result of the operation in case of
failure or cancellation." |
| 820 }, |
| 821 "metadata": { |
| 822 "additionalProperties": { |
| 823 "description": "Properties of the object. Contains field
@type with type URL.", |
| 824 "type": "any" |
| 825 }, |
| 826 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", |
| 827 "type": "object" |
| 828 } |
| 829 }, |
| 830 "type": "object" |
831 } | 831 } |
832 }, | 832 }, |
833 "servicePath": "", | 833 "servicePath": "", |
834 "title": "Google Cloud Resource Manager API", | 834 "title": "Google Cloud Resource Manager API", |
835 "version": "v2beta1" | 835 "version": "v2beta1" |
836 } | 836 } |
OLD | NEW |