OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
9 "description": "View your data across Google Cloud Platform
services" | 9 "description": "View your data across Google Cloud Platform
services" |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://cloudresourcemanager.googleapis.com/", | 15 "baseUrl": "https://cloudresourcemanager.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Cloud Resource Manager", | 17 "canonicalName": "Cloud Resource Manager", |
18 "description": "The Google Cloud Resource Manager API provides methods for c
reating, reading, and updating project metadata.", | 18 "description": "The Google Cloud Resource Manager API provides methods for c
reating, reading, and updating project metadata.", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://cloud.google.com/resource-manager", | 20 "documentationLink": "https://cloud.google.com/resource-manager", |
21 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/KvNq14l55QtltcB7NZiPRgJYtsY\"", | 21 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/KWbv1ck4Hir_ldCgHUUAxKHck4c\"", |
22 "icons": { | 22 "icons": { |
23 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 23 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
24 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 24 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
25 }, | 25 }, |
26 "id": "cloudresourcemanager:v1", | 26 "id": "cloudresourcemanager:v1", |
27 "kind": "discovery#restDescription", | 27 "kind": "discovery#restDescription", |
28 "name": "cloudresourcemanager", | 28 "name": "cloudresourcemanager", |
29 "ownerDomain": "google.com", | 29 "ownerDomain": "google.com", |
30 "ownerName": "Google", | 30 "ownerName": "Google", |
31 "parameters": { | 31 "parameters": { |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
102 "enumDescriptions": [ | 102 "enumDescriptions": [ |
103 "v1 error format", | 103 "v1 error format", |
104 "v2 error format" | 104 "v2 error format" |
105 ], | 105 ], |
106 "location": "query", | 106 "location": "query", |
107 "type": "string" | 107 "type": "string" |
108 } | 108 } |
109 }, | 109 }, |
110 "protocol": "rest", | 110 "protocol": "rest", |
111 "resources": { | 111 "resources": { |
| 112 "operations": { |
| 113 "methods": { |
| 114 "get": { |
| 115 "description": "Gets the latest state of a long-running oper
ation. Clients can use this method to poll the operation result at intervals as
recommended by the API service.", |
| 116 "httpMethod": "GET", |
| 117 "id": "cloudresourcemanager.operations.get", |
| 118 "parameterOrder": [ |
| 119 "name" |
| 120 ], |
| 121 "parameters": { |
| 122 "name": { |
| 123 "description": "The name of the operation resource."
, |
| 124 "location": "path", |
| 125 "pattern": "^operations/.*$", |
| 126 "required": true, |
| 127 "type": "string" |
| 128 } |
| 129 }, |
| 130 "path": "v1/{+name}", |
| 131 "response": { |
| 132 "$ref": "Operation" |
| 133 }, |
| 134 "scopes": [ |
| 135 "https://www.googleapis.com/auth/cloud-platform", |
| 136 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 137 ] |
| 138 } |
| 139 } |
| 140 }, |
| 141 "organizations": { |
| 142 "methods": { |
| 143 "search": { |
| 144 "description": "Searches Organization resources that are vis
ible to the user and satisfy the specified filter. This method returns Organizat
ions in an unspecified order. New Organizations do not necessarily appear at the
end of the results.", |
| 145 "httpMethod": "POST", |
| 146 "id": "cloudresourcemanager.organizations.search", |
| 147 "path": "v1/organizations:search", |
| 148 "request": { |
| 149 "$ref": "SearchOrganizationsRequest" |
| 150 }, |
| 151 "response": { |
| 152 "$ref": "SearchOrganizationsResponse" |
| 153 }, |
| 154 "scopes": [ |
| 155 "https://www.googleapis.com/auth/cloud-platform", |
| 156 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 157 ] |
| 158 }, |
| 159 "get": { |
| 160 "description": "Fetches an Organization resource identified
by the specified resource name.", |
| 161 "httpMethod": "GET", |
| 162 "id": "cloudresourcemanager.organizations.get", |
| 163 "parameterOrder": [ |
| 164 "name" |
| 165 ], |
| 166 "parameters": { |
| 167 "name": { |
| 168 "description": "The resource name of the Organizatio
n to fetch, e.g. \"organizations/1234\".", |
| 169 "location": "path", |
| 170 "pattern": "^organizations/[^/]*$", |
| 171 "required": true, |
| 172 "type": "string" |
| 173 } |
| 174 }, |
| 175 "path": "v1/{+name}", |
| 176 "response": { |
| 177 "$ref": "Organization" |
| 178 }, |
| 179 "scopes": [ |
| 180 "https://www.googleapis.com/auth/cloud-platform", |
| 181 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 182 ] |
| 183 }, |
| 184 "setIamPolicy": { |
| 185 "description": "Sets the access control policy on an Organiz
ation resource. Replaces any existing policy. The `resource` field should be the
organization's resource name, e.g. \"organizations/123\".", |
| 186 "httpMethod": "POST", |
| 187 "id": "cloudresourcemanager.organizations.setIamPolicy", |
| 188 "parameterOrder": [ |
| 189 "resource" |
| 190 ], |
| 191 "parameters": { |
| 192 "resource": { |
| 193 "description": "REQUIRED: The resource for which the
policy is being specified. `resource` is usually specified as a path. For examp
le, a Project resource is specified as `projects/{project}`.", |
| 194 "location": "path", |
| 195 "pattern": "^organizations/[^/]*$", |
| 196 "required": true, |
| 197 "type": "string" |
| 198 } |
| 199 }, |
| 200 "path": "v1/{+resource}:setIamPolicy", |
| 201 "request": { |
| 202 "$ref": "SetIamPolicyRequest" |
| 203 }, |
| 204 "response": { |
| 205 "$ref": "Policy" |
| 206 }, |
| 207 "scopes": [ |
| 208 "https://www.googleapis.com/auth/cloud-platform" |
| 209 ] |
| 210 }, |
| 211 "getIamPolicy": { |
| 212 "description": "Gets the access control policy for an Organi
zation resource. May be empty if no such policy or resource exists. The `resourc
e` field should be the organization's resource name, e.g. \"organizations/123\".
", |
| 213 "httpMethod": "POST", |
| 214 "id": "cloudresourcemanager.organizations.getIamPolicy", |
| 215 "parameterOrder": [ |
| 216 "resource" |
| 217 ], |
| 218 "parameters": { |
| 219 "resource": { |
| 220 "description": "REQUIRED: The resource for which the
policy is being requested. `resource` is usually specified as a path. For examp
le, a Project resource is specified as `projects/{project}`.", |
| 221 "location": "path", |
| 222 "pattern": "^organizations/[^/]*$", |
| 223 "required": true, |
| 224 "type": "string" |
| 225 } |
| 226 }, |
| 227 "path": "v1/{+resource}:getIamPolicy", |
| 228 "request": { |
| 229 "$ref": "GetIamPolicyRequest" |
| 230 }, |
| 231 "response": { |
| 232 "$ref": "Policy" |
| 233 }, |
| 234 "scopes": [ |
| 235 "https://www.googleapis.com/auth/cloud-platform", |
| 236 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 237 ] |
| 238 }, |
| 239 "testIamPermissions": { |
| 240 "description": "Returns permissions that a caller has on the
specified Organization. The `resource` field should be the organization's resou
rce name, e.g. \"organizations/123\".", |
| 241 "httpMethod": "POST", |
| 242 "id": "cloudresourcemanager.organizations.testIamPermissions
", |
| 243 "parameterOrder": [ |
| 244 "resource" |
| 245 ], |
| 246 "parameters": { |
| 247 "resource": { |
| 248 "description": "REQUIRED: The resource for which the
policy detail is being requested. `resource` is usually specified as a path. Fo
r example, a Project resource is specified as `projects/{project}`.", |
| 249 "location": "path", |
| 250 "pattern": "^organizations/[^/]*$", |
| 251 "required": true, |
| 252 "type": "string" |
| 253 } |
| 254 }, |
| 255 "path": "v1/{+resource}:testIamPermissions", |
| 256 "request": { |
| 257 "$ref": "TestIamPermissionsRequest" |
| 258 }, |
| 259 "response": { |
| 260 "$ref": "TestIamPermissionsResponse" |
| 261 }, |
| 262 "scopes": [ |
| 263 "https://www.googleapis.com/auth/cloud-platform", |
| 264 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 265 ] |
| 266 } |
| 267 } |
| 268 }, |
112 "projects": { | 269 "projects": { |
113 "methods": { | 270 "methods": { |
114 "get": { | 271 "get": { |
115 "description": "Retrieves the Project identified by the spec
ified `project_id` (for example, `my-project-123`). The caller must have read pe
rmissions for this Project.", | 272 "description": "Retrieves the Project identified by the spec
ified `project_id` (for example, `my-project-123`). The caller must have read pe
rmissions for this Project.", |
116 "httpMethod": "GET", | 273 "httpMethod": "GET", |
117 "id": "cloudresourcemanager.projects.get", | 274 "id": "cloudresourcemanager.projects.get", |
118 "parameterOrder": [ | 275 "parameterOrder": [ |
119 "projectId" | 276 "projectId" |
120 ], | 277 ], |
121 "parameters": { | 278 "parameters": { |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
159 }, | 316 }, |
160 "path": "v1/projects", | 317 "path": "v1/projects", |
161 "response": { | 318 "response": { |
162 "$ref": "ListProjectsResponse" | 319 "$ref": "ListProjectsResponse" |
163 }, | 320 }, |
164 "scopes": [ | 321 "scopes": [ |
165 "https://www.googleapis.com/auth/cloud-platform", | 322 "https://www.googleapis.com/auth/cloud-platform", |
166 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 323 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
167 ] | 324 ] |
168 }, | 325 }, |
| 326 "create": { |
| 327 "description": "Request that a new Project be created. The r
esult is an Operation which can be used to track the creation process. It is aut
omatically deleted after a few hours, so there is no need to call DeleteOperatio
n. Our SLO permits Project creation to take up to 30 seconds at the 90th percent
ile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th
percentile latency is around 11 seconds. We recommend polling at the 5th second
with an exponential backoff.", |
| 328 "httpMethod": "POST", |
| 329 "id": "cloudresourcemanager.projects.create", |
| 330 "path": "v1/projects", |
| 331 "request": { |
| 332 "$ref": "Project" |
| 333 }, |
| 334 "response": { |
| 335 "$ref": "Operation" |
| 336 }, |
| 337 "scopes": [ |
| 338 "https://www.googleapis.com/auth/cloud-platform" |
| 339 ] |
| 340 }, |
169 "update": { | 341 "update": { |
170 "description": "Updates the attributes of the Project identi
fied by the specified `project_id` (for example, `my-project-123`). The caller m
ust have modify permissions for this Project.", | 342 "description": "Updates the attributes of the Project identi
fied by the specified `project_id` (for example, `my-project-123`). The caller m
ust have modify permissions for this Project.", |
171 "httpMethod": "PUT", | 343 "httpMethod": "PUT", |
172 "id": "cloudresourcemanager.projects.update", | 344 "id": "cloudresourcemanager.projects.update", |
173 "parameterOrder": [ | 345 "parameterOrder": [ |
174 "projectId" | 346 "projectId" |
175 ], | 347 ], |
176 "parameters": { | 348 "parameters": { |
177 "projectId": { | 349 "projectId": { |
178 "description": "The project ID (for example, `my-pro
ject-123`). Required.", | 350 "description": "The project ID (for example, `my-pro
ject-123`). Required.", |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
243 }, | 415 }, |
244 "getIamPolicy": { | 416 "getIamPolicy": { |
245 "description": "Returns the IAM access control policy for th
e specified Project. Permission is denied if the policy or the resource does not
exist.", | 417 "description": "Returns the IAM access control policy for th
e specified Project. Permission is denied if the policy or the resource does not
exist.", |
246 "httpMethod": "POST", | 418 "httpMethod": "POST", |
247 "id": "cloudresourcemanager.projects.getIamPolicy", | 419 "id": "cloudresourcemanager.projects.getIamPolicy", |
248 "parameterOrder": [ | 420 "parameterOrder": [ |
249 "resource" | 421 "resource" |
250 ], | 422 ], |
251 "parameters": { | 423 "parameters": { |
252 "resource": { | 424 "resource": { |
253 "description": "REQUIRED: The resource for which the
policy is being requested. `resource` is usually specified as a path, such as `
projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified
in this value is resource specific and is specified in the `getIamPolicy` docum
entation.", | 425 "description": "REQUIRED: The resource for which the
policy is being requested. `resource` is usually specified as a path. For examp
le, a Project resource is specified as `projects/{project}`.", |
254 "location": "path", | 426 "location": "path", |
255 "required": true, | 427 "required": true, |
256 "type": "string" | 428 "type": "string" |
257 } | 429 } |
258 }, | 430 }, |
259 "path": "v1/projects/{resource}:getIamPolicy", | 431 "path": "v1/projects/{resource}:getIamPolicy", |
260 "request": { | 432 "request": { |
261 "$ref": "GetIamPolicyRequest" | 433 "$ref": "GetIamPolicyRequest" |
262 }, | 434 }, |
263 "response": { | 435 "response": { |
264 "$ref": "Policy" | 436 "$ref": "Policy" |
265 }, | 437 }, |
266 "scopes": [ | 438 "scopes": [ |
267 "https://www.googleapis.com/auth/cloud-platform", | 439 "https://www.googleapis.com/auth/cloud-platform", |
268 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 440 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
269 ] | 441 ] |
270 }, | 442 }, |
271 "setIamPolicy": { | 443 "setIamPolicy": { |
272 "description": "Sets the IAM access control policy for the s
pecified Project. Replaces any existing policy. The following constraints apply
when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthe
nticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can b
e granted only to `user` and `serviceAccount`. + Service accounts can be made ow
ners of a project directly without any restrictions. However, to be added as an
owner, a user must be invited via Cloud Platform console and must accept the inv
itation. + A user cannot be granted the owner role using `setIamPolicy()`. The u
ser must be granted the owner role using the Cloud Platform Console and must exp
licitly accept the invitation. + Invitations to grant the owner role cannot be s
ent using `setIamPolicy()`; they must be sent only using the Cloud Platform Cons
ole. + Membership changes that leave the project without any owners that have ac
cepted the Terms of Service (ToS) will be rejected. + Members cannot be added to
more than one role in the same policy. + There must be at least one owner who h
as accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamP
olicy()` to to remove the last ToS-accepted owner from the policy will fail. Thi
s restriction also applies to legacy projects that no longer have owners who hav
e accepted the ToS. Edits to IAM policies will be rejected until the lack of a T
oS-accepting owner is rectified. + Calling this method requires enabling the App
Engine Admin API. Note: Removing service accounts from policies or changing the
ir roles can render services completely inoperable. It is important to understan
d how the service account is being used before removing or updating its roles.", | 444 "description": "Sets the IAM access control policy for the s
pecified Project. Replaces any existing policy. The following constraints apply
when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthe
nticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can b
e granted only to `user` and `serviceAccount`. + Service accounts can be made ow
ners of a project directly without any restrictions. However, to be added as an
owner, a user must be invited via Cloud Platform console and must accept the inv
itation. + A user cannot be granted the owner role using `setIamPolicy()`. The u
ser must be granted the owner role using the Cloud Platform Console and must exp
licitly accept the invitation. + Invitations to grant the owner role cannot be s
ent using `setIamPolicy()`; they must be sent only using the Cloud Platform Cons
ole. + Membership changes that leave the project without any owners that have ac
cepted the Terms of Service (ToS) will be rejected. + There must be at least one
owner who has accepted the Terms of Service (ToS) agreement in the policy. Call
ing `setIamPolicy()` to to remove the last ToS-accepted owner from the policy wi
ll fail. This restriction also applies to legacy projects that no longer have ow
ners who have accepted the ToS. Edits to IAM policies will be rejected until the
lack of a ToS-accepting owner is rectified. + Calling this method requires enab
ling the App Engine Admin API. Note: Removing service accounts from policies or
changing their roles can render services completely inoperable. It is important
to understand how the service account is being used before removing or updating
its roles.", |
273 "httpMethod": "POST", | 445 "httpMethod": "POST", |
274 "id": "cloudresourcemanager.projects.setIamPolicy", | 446 "id": "cloudresourcemanager.projects.setIamPolicy", |
275 "parameterOrder": [ | 447 "parameterOrder": [ |
276 "resource" | 448 "resource" |
277 ], | 449 ], |
278 "parameters": { | 450 "parameters": { |
279 "resource": { | 451 "resource": { |
280 "description": "REQUIRED: The resource for which the
policy is being specified. `resource` is usually specified as a path, such as `
projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified
in this value is resource specific and is specified in the `setIamPolicy` docum
entation.", | 452 "description": "REQUIRED: The resource for which the
policy is being specified. `resource` is usually specified as a path. For examp
le, a Project resource is specified as `projects/{project}`.", |
281 "location": "path", | 453 "location": "path", |
282 "required": true, | 454 "required": true, |
283 "type": "string" | 455 "type": "string" |
284 } | 456 } |
285 }, | 457 }, |
286 "path": "v1/projects/{resource}:setIamPolicy", | 458 "path": "v1/projects/{resource}:setIamPolicy", |
287 "request": { | 459 "request": { |
288 "$ref": "SetIamPolicyRequest" | 460 "$ref": "SetIamPolicyRequest" |
289 }, | 461 }, |
290 "response": { | 462 "response": { |
291 "$ref": "Policy" | 463 "$ref": "Policy" |
292 }, | 464 }, |
293 "scopes": [ | 465 "scopes": [ |
294 "https://www.googleapis.com/auth/cloud-platform" | 466 "https://www.googleapis.com/auth/cloud-platform" |
295 ] | 467 ] |
296 }, | 468 }, |
297 "testIamPermissions": { | 469 "testIamPermissions": { |
298 "description": "Returns permissions that a caller has on the
specified Project.", | 470 "description": "Returns permissions that a caller has on the
specified Project.", |
299 "httpMethod": "POST", | 471 "httpMethod": "POST", |
300 "id": "cloudresourcemanager.projects.testIamPermissions", | 472 "id": "cloudresourcemanager.projects.testIamPermissions", |
301 "parameterOrder": [ | 473 "parameterOrder": [ |
302 "resource" | 474 "resource" |
303 ], | 475 ], |
304 "parameters": { | 476 "parameters": { |
305 "resource": { | 477 "resource": { |
306 "description": "REQUIRED: The resource for which the
policy detail is being requested. `resource` is usually specified as a path, su
ch as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path sp
ecified in this value is resource specific and is specified in the `testIamPermi
ssions` documentation.", | 478 "description": "REQUIRED: The resource for which the
policy detail is being requested. `resource` is usually specified as a path. Fo
r example, a Project resource is specified as `projects/{project}`.", |
307 "location": "path", | 479 "location": "path", |
308 "required": true, | 480 "required": true, |
309 "type": "string" | 481 "type": "string" |
310 } | 482 } |
311 }, | 483 }, |
312 "path": "v1/projects/{resource}:testIamPermissions", | 484 "path": "v1/projects/{resource}:testIamPermissions", |
313 "request": { | 485 "request": { |
314 "$ref": "TestIamPermissionsRequest" | 486 "$ref": "TestIamPermissionsRequest" |
315 }, | 487 }, |
316 "response": { | 488 "response": { |
317 "$ref": "TestIamPermissionsResponse" | 489 "$ref": "TestIamPermissionsResponse" |
318 }, | 490 }, |
319 "scopes": [ | 491 "scopes": [ |
320 "https://www.googleapis.com/auth/cloud-platform", | 492 "https://www.googleapis.com/auth/cloud-platform", |
321 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 493 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
322 ] | 494 ] |
323 } | 495 } |
324 } | 496 } |
325 }, | |
326 "operations": { | |
327 "methods": { | |
328 "get": { | |
329 "description": "Gets the latest state of a long-running oper
ation. Clients can use this method to poll the operation result at intervals as
recommended by the API service.", | |
330 "httpMethod": "GET", | |
331 "id": "cloudresourcemanager.operations.get", | |
332 "parameterOrder": [ | |
333 "name" | |
334 ], | |
335 "parameters": { | |
336 "name": { | |
337 "description": "The name of the operation resource."
, | |
338 "location": "path", | |
339 "pattern": "^operations/.*$", | |
340 "required": true, | |
341 "type": "string" | |
342 } | |
343 }, | |
344 "path": "v1/{+name}", | |
345 "response": { | |
346 "$ref": "Operation" | |
347 }, | |
348 "scopes": [ | |
349 "https://www.googleapis.com/auth/cloud-platform", | |
350 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
351 ] | |
352 } | |
353 } | |
354 } | 497 } |
355 }, | 498 }, |
356 "revision": "20160617", | 499 "revision": "20160927", |
357 "rootUrl": "https://cloudresourcemanager.googleapis.com/", | 500 "rootUrl": "https://cloudresourcemanager.googleapis.com/", |
358 "schemas": { | 501 "schemas": { |
359 "Project": { | 502 "Operation": { |
360 "description": "A Project is a high-level Google Cloud Platform enti
ty. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Clou
d Platform resources.", | 503 "description": "This resource represents a long-running operation th
at is the result of a network API call.", |
361 "id": "Project", | 504 "id": "Operation", |
362 "properties": { | 505 "properties": { |
363 "projectNumber": { | 506 "name": { |
364 "description": "The number uniquely identifying the project.
Example: 415104041262 Read-only.", | 507 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping, the `name` should have the format of `operations/some/unique/name`."
, |
365 "format": "int64", | |
366 "type": "string" | 508 "type": "string" |
367 }, | 509 }, |
368 "projectId": { | 510 "metadata": { |
369 "description": "The unique, user-assigned ID of the Project.
It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a
letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after
creation.", | |
370 "type": "string" | |
371 }, | |
372 "lifecycleState": { | |
373 "description": "The Project lifecycle state. Read-only.", | |
374 "enum": [ | |
375 "LIFECYCLE_STATE_UNSPECIFIED", | |
376 "ACTIVE", | |
377 "DELETE_REQUESTED", | |
378 "DELETE_IN_PROGRESS" | |
379 ], | |
380 "type": "string" | |
381 }, | |
382 "name": { | |
383 "description": "The user-assigned display name of the Projec
t. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercas
e letters, numbers, hyphen, single-quote, double-quote, space, and exclamation p
oint. Example: My Project Read-write.", | |
384 "type": "string" | |
385 }, | |
386 "createTime": { | |
387 "description": "Creation time. Read-only.", | |
388 "type": "string" | |
389 }, | |
390 "labels": { | |
391 "additionalProperties": { | 511 "additionalProperties": { |
392 "type": "string" | 512 "description": "Properties of the object. Contains field
@type with type URL.", |
| 513 "type": "any" |
393 }, | 514 }, |
394 "description": "The labels associated with this Project. Lab
el keys must be between 1 and 63 characters long and must conform to the followi
ng regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must
be between 0 and 63 characters long and must conform to the regular expression
(\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 256 labels can be associ
ated with a given resource. Clients should store labels in a representation such
as JSON that does not depend on specific characters being disallowed. Example:
\"environment\" : \"dev\" Read-write.", | 515 "description": "Service-specific metadata associated with th
e 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.", |
395 "type": "object" | 516 "type": "object" |
396 }, | 517 }, |
397 "parent": { | 518 "done": { |
398 "$ref": "ResourceId", | 519 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed, and either `error
` or `response` is available.", |
399 "description": "An optional reference to a parent Resource.
The only supported parent type is \"organization\". Once set, the parent cannot
be modified. Read-write." | 520 "type": "boolean" |
| 521 }, |
| 522 "error": { |
| 523 "$ref": "Status", |
| 524 "description": "The error result of the operation in case of
failure." |
| 525 }, |
| 526 "response": { |
| 527 "additionalProperties": { |
| 528 "description": "Properties of the object. Contains field
@type with type URL.", |
| 529 "type": "any" |
| 530 }, |
| 531 "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 `G
et`/`Create`/`Update`, the response should be the resource. For other methods, t
he response should have the type `XxxResponse`, where `Xxx` is the original meth
od name. For example, if the original method name is `TakeSnapshot()`, the infer
red response type is `TakeSnapshotResponse`.", |
| 532 "type": "object" |
400 } | 533 } |
401 }, | 534 }, |
402 "type": "object" | 535 "type": "object" |
403 }, | 536 }, |
404 "ResourceId": { | 537 "Status": { |
405 "description": "A container to reference an id for any resource type
. A `resource` in Google Cloud Platform is a generic term for something you (a d
eveloper) may want to interact with through one of our API's. Some examples are
an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on.", | 538 "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). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of google.rpc.Code, but it may accept additional error codes if needed. Th
e error message should be a developer-facing English message that helps develope
rs *understand* and *resolve* the error. If a localized user-facing error messag
e is needed, put the localized message in the error details or localize it in th
e client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.r
pc` which can be used for common error conditions. # Language mapping The `Statu
s` message is the logical representation of the error model, but it is not neces
sarily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. Fo
r example, it will likely be mapped to some exceptions in Java, but more likely
mapped to some error codes in C. # Other uses The error model and the `Status` m
essage can be used in a variety of environments, either with or without APIs, to
provide a consistent developer experience across different environments. Exampl
e uses of this error model include: - Partial errors. If a service needs to retu
rn partial errors to the client, it may embed the `Status` in the normal respons
e to indicate the partial errors. - Workflow errors. A typical workflow has mult
iple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Statu
s` message should be used directly inside batch response, one for each error sub
-response. - Asynchronous operations. If an API call embeds asynchronous operati
on results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored i
n logs, the message `Status` could be used directly after any stripping needed f
or security/privacy reasons.", |
406 "id": "ResourceId", | 539 "id": "Status", |
407 "properties": { | 540 "properties": { |
408 "type": { | 541 "code": { |
409 "description": "Required field representing the resource typ
e this id is for. At present, the only valid type is \"organization\".", | 542 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 543 "format": "int32", |
| 544 "type": "integer" |
| 545 }, |
| 546 "message": { |
| 547 "description": "A developer-facing error message, which shou
ld 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.", |
410 "type": "string" | 548 "type": "string" |
411 }, | 549 }, |
412 "id": { | 550 "details": { |
413 "description": "Required field for the type-specific id. Thi
s should correspond to the id used in the type-specific API's.", | 551 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", |
| 552 "items": { |
| 553 "additionalProperties": { |
| 554 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 555 "type": "any" |
| 556 }, |
| 557 "type": "object" |
| 558 }, |
| 559 "type": "array" |
| 560 } |
| 561 }, |
| 562 "type": "object" |
| 563 }, |
| 564 "SearchOrganizationsRequest": { |
| 565 "description": "The request sent to the `SearchOrganizations` method
.", |
| 566 "id": "SearchOrganizationsRequest", |
| 567 "properties": { |
| 568 "pageSize": { |
| 569 "description": "The maximum number of Organizations to retur
n in the response. This field is optional.", |
| 570 "format": "int32", |
| 571 "type": "integer" |
| 572 }, |
| 573 "pageToken": { |
| 574 "description": "A pagination token returned from a previous
call to `SearchOrganizations` that indicates from where listing should continue.
This field is optional.", |
| 575 "type": "string" |
| 576 }, |
| 577 "filter": { |
| 578 "description": "An optional query string used to filter the
Organizations to return in the response. Filter rules are case-insensitive. Orga
nizations may be filtered by `owner.directoryCustomerId` or by `domain`, where t
he domain is a Google for Work domain, for example: |Filter|Description| |------
|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.dir
ectory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corr
esponding to the domain `google.com`.| This field is optional.", |
414 "type": "string" | 579 "type": "string" |
415 } | 580 } |
416 }, | 581 }, |
417 "type": "object" | 582 "type": "object" |
418 }, | 583 }, |
419 "ListProjectsResponse": { | 584 "SearchOrganizationsResponse": { |
420 "description": "A page of the response received from the ListProject
s method. A paginated response where more pages are available has `next_page_tok
en` set. This token can be used in a subsequent request to retrieve the next req
uest page.", | 585 "description": "The response returned from the `SearchOrganizations`
method.", |
421 "id": "ListProjectsResponse", | 586 "id": "SearchOrganizationsResponse", |
422 "properties": { | 587 "properties": { |
423 "projects": { | 588 "organizations": { |
424 "description": "The list of Projects that matched the list f
ilter. This list can be paginated.", | 589 "description": "The list of Organizations that matched the s
earch query, possibly paginated.", |
425 "items": { | 590 "items": { |
426 "$ref": "Project" | 591 "$ref": "Organization" |
427 }, | 592 }, |
428 "type": "array" | 593 "type": "array" |
429 }, | 594 }, |
430 "nextPageToken": { | 595 "nextPageToken": { |
431 "description": "Pagination token. If the result set is too l
arge to fit in a single response, this token is returned. It encodes the positio
n of the current result cursor. Feeding this value into a new list request with
the `page_token` parameter gives the next page of the results. When `next_page_t
oken` is not filled in, there is no next page and the list returned is the last
page in the result set. Pagination tokens have a limited lifetime.", | 596 "description": "A pagination token to be used to retrieve th
e next page of results. If the result is too large to fit within the page size s
pecified in the request, this field will be set with a token that can be used to
fetch the next page of results. If this field is empty, it indicates that this
response contains the last page of results.", |
432 "type": "string" | 597 "type": "string" |
433 } | 598 } |
434 }, | 599 }, |
435 "type": "object" | 600 "type": "object" |
436 }, | 601 }, |
437 "Empty": { | 602 "Organization": { |
438 "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 re
presentation for `Empty` is empty JSON object `{}`.", | 603 "description": "The root node in the resource hierarchy to which a p
articular entity's (e.g., company) resources belong.", |
439 "id": "Empty", | 604 "id": "Organization", |
| 605 "properties": { |
| 606 "name": { |
| 607 "description": "Output Only. The resource name of the organi
zation. This is the organization's relative path in the API. Its format is \"org
anizations/[organization_id]\". For example, \"organizations/1234\".", |
| 608 "type": "string" |
| 609 }, |
| 610 "displayName": { |
| 611 "description": "A friendly string to be used to refer to the
Organization in the UI. Assigned by the server, set to the firm name of the Goo
gle For Work customer that owns this organization. @OutputOnly", |
| 612 "type": "string" |
| 613 }, |
| 614 "owner": { |
| 615 "$ref": "OrganizationOwner", |
| 616 "description": "The owner of this Organization. The owner sh
ould be specified on creation. Once set, it cannot be changed. This field is req
uired." |
| 617 }, |
| 618 "creationTime": { |
| 619 "description": "Timestamp when the Organization was created.
Assigned by the server. @OutputOnly", |
| 620 "type": "string" |
| 621 }, |
| 622 "lifecycleState": { |
| 623 "description": "The organization's current lifecycle state.
Assigned by the server. @OutputOnly", |
| 624 "enum": [ |
| 625 "LIFECYCLE_STATE_UNSPECIFIED", |
| 626 "ACTIVE", |
| 627 "DELETE_REQUESTED" |
| 628 ], |
| 629 "type": "string" |
| 630 } |
| 631 }, |
440 "type": "object" | 632 "type": "object" |
441 }, | 633 }, |
442 "UndeleteProjectRequest": { | 634 "OrganizationOwner": { |
443 "description": "The request sent to the UndeleteProject method.", | 635 "description": "The entity that owns an Organization. The lifetime o
f the Organization and all of its descendants are bound to the `OrganizationOwne
r`. If the `OrganizationOwner` is deleted, the Organization and all its descenda
nts will be deleted.", |
444 "id": "UndeleteProjectRequest", | 636 "id": "OrganizationOwner", |
| 637 "properties": { |
| 638 "directoryCustomerId": { |
| 639 "description": "The Google for Work customer id used in the
Directory API.", |
| 640 "type": "string" |
| 641 } |
| 642 }, |
445 "type": "object" | 643 "type": "object" |
446 }, | 644 }, |
447 "GetIamPolicyRequest": { | 645 "SetIamPolicyRequest": { |
448 "description": "Request message for `GetIamPolicy` method.", | 646 "description": "Request message for `SetIamPolicy` method.", |
449 "id": "GetIamPolicyRequest", | 647 "id": "SetIamPolicyRequest", |
| 648 "properties": { |
| 649 "policy": { |
| 650 "$ref": "Policy", |
| 651 "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 empt
y policy is a valid policy but certain Cloud Platform services (such as Projects
) might reject them." |
| 652 } |
| 653 }, |
450 "type": "object" | 654 "type": "object" |
451 }, | 655 }, |
452 "Policy": { | 656 "Policy": { |
453 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `member
s` to a `role`, where the members can be user accounts, Google groups, Google do
mains, and service accounts. A `role` is a named list of permissions defined by
IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \
"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \
"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"r
oles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description
of IAM and its features, see the [IAM developer's guide](https://cloud.google.co
m/iam).", | 657 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `member
s` to a `role`, where the members can be user accounts, Google groups, Google do
mains, and service accounts. A `role` is a named list of permissions defined by
IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \
"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \
"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"r
oles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description
of IAM and its features, see the [IAM developer's guide](https://cloud.google.co
m/iam).", |
454 "id": "Policy", | 658 "id": "Policy", |
455 "properties": { | 659 "properties": { |
456 "version": { | 660 "version": { |
457 "description": "Version of the `Policy`. The default version
is 0.", | 661 "description": "Version of the `Policy`. The default version
is 0.", |
458 "format": "int32", | 662 "format": "int32", |
459 "type": "integer" | 663 "type": "integer" |
(...skipping 24 matching lines...) Expand all Loading... |
484 "members": { | 688 "members": { |
485 "description": "Specifies the identities requesting access f
or a Cloud Platform resource. `members` can have the following values: * `allUse
rs`: 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 accoun
t. * `user:{emailid}`: An email address that represents a specific Google accoun
t. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{email
id}`: An email address that represents a service account. For example, `my-other
-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that re
presents a Google group. For example, `admins@example.com`. * `domain:{domain}`:
A Google Apps domain name that represents all the users of that domain. For exa
mple, `google.com` or `example.com`.", | 689 "description": "Specifies the identities requesting access f
or a Cloud Platform resource. `members` can have the following values: * `allUse
rs`: 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 accoun
t. * `user:{emailid}`: An email address that represents a specific Google accoun
t. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{email
id}`: An email address that represents a service account. For example, `my-other
-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that re
presents a Google group. For example, `admins@example.com`. * `domain:{domain}`:
A Google Apps domain name that represents all the users of that domain. For exa
mple, `google.com` or `example.com`.", |
486 "items": { | 690 "items": { |
487 "type": "string" | 691 "type": "string" |
488 }, | 692 }, |
489 "type": "array" | 693 "type": "array" |
490 } | 694 } |
491 }, | 695 }, |
492 "type": "object" | 696 "type": "object" |
493 }, | 697 }, |
494 "SetIamPolicyRequest": { | 698 "GetIamPolicyRequest": { |
495 "description": "Request message for `SetIamPolicy` method.", | 699 "description": "Request message for `GetIamPolicy` method.", |
496 "id": "SetIamPolicyRequest", | 700 "id": "GetIamPolicyRequest", |
497 "properties": { | |
498 "policy": { | |
499 "$ref": "Policy", | |
500 "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 empt
y policy is a valid policy but certain Cloud Platform services (such as Projects
) might reject them." | |
501 } | |
502 }, | |
503 "type": "object" | 701 "type": "object" |
504 }, | 702 }, |
505 "TestIamPermissionsRequest": { | 703 "TestIamPermissionsRequest": { |
506 "description": "Request message for `TestIamPermissions` method.", | 704 "description": "Request message for `TestIamPermissions` method.", |
507 "id": "TestIamPermissionsRequest", | 705 "id": "TestIamPermissionsRequest", |
508 "properties": { | 706 "properties": { |
509 "permissions": { | 707 "permissions": { |
510 "description": "The set of permissions to check for the `res
ource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
For more information see IAM Overview.", | 708 "description": "The set of permissions to check for the `res
ource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
For more information see [IAM Overview](https://cloud.google.com/iam/docs/overv
iew#permissions).", |
511 "items": { | 709 "items": { |
512 "type": "string" | 710 "type": "string" |
513 }, | 711 }, |
514 "type": "array" | 712 "type": "array" |
515 } | 713 } |
516 }, | 714 }, |
517 "type": "object" | 715 "type": "object" |
518 }, | 716 }, |
519 "TestIamPermissionsResponse": { | 717 "TestIamPermissionsResponse": { |
520 "description": "Response message for `TestIamPermissions` method.", | 718 "description": "Response message for `TestIamPermissions` method.", |
521 "id": "TestIamPermissionsResponse", | 719 "id": "TestIamPermissionsResponse", |
522 "properties": { | 720 "properties": { |
523 "permissions": { | 721 "permissions": { |
524 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is allowed.", | 722 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is allowed.", |
525 "items": { | 723 "items": { |
526 "type": "string" | 724 "type": "string" |
527 }, | 725 }, |
528 "type": "array" | 726 "type": "array" |
529 } | 727 } |
530 }, | 728 }, |
531 "type": "object" | 729 "type": "object" |
532 }, | 730 }, |
533 "Operation": { | 731 "Project": { |
534 "description": "This resource represents a long-running operation th
at is the result of a network API call.", | 732 "description": "A Project is a high-level Google Cloud Platform enti
ty. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Clou
d Platform resources.", |
535 "id": "Operation", | 733 "id": "Project", |
536 "properties": { | 734 "properties": { |
537 "name": { | 735 "projectNumber": { |
538 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping, the `name` should have the format of `operations/some/unique/name`."
, | 736 "description": "The number uniquely identifying the project.
Example: 415104041262 Read-only.", |
| 737 "format": "int64", |
539 "type": "string" | 738 "type": "string" |
540 }, | 739 }, |
541 "metadata": { | 740 "projectId": { |
| 741 "description": "The unique, user-assigned ID of the Project.
It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a
letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after
creation.", |
| 742 "type": "string" |
| 743 }, |
| 744 "lifecycleState": { |
| 745 "description": "The Project lifecycle state. Read-only.", |
| 746 "enum": [ |
| 747 "LIFECYCLE_STATE_UNSPECIFIED", |
| 748 "ACTIVE", |
| 749 "DELETE_REQUESTED", |
| 750 "DELETE_IN_PROGRESS" |
| 751 ], |
| 752 "type": "string" |
| 753 }, |
| 754 "name": { |
| 755 "description": "The user-assigned display name of the Projec
t. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercas
e letters, numbers, hyphen, single-quote, double-quote, space, and exclamation p
oint. Example: My Project Read-write.", |
| 756 "type": "string" |
| 757 }, |
| 758 "createTime": { |
| 759 "description": "Creation time. Read-only.", |
| 760 "type": "string" |
| 761 }, |
| 762 "labels": { |
542 "additionalProperties": { | 763 "additionalProperties": { |
543 "description": "Properties of the object. Contains field
@ype with type URL.", | 764 "type": "string" |
544 "type": "any" | |
545 }, | 765 }, |
546 "description": "Service-specific metadata associated with th
e 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.", | 766 "description": "The labels associated with this Project. Lab
el keys must be between 1 and 63 characters long and must conform to the followi
ng regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must
be between 0 and 63 characters long and must conform to the regular expression
(\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 256 labels can be associ
ated with a given resource. Clients should store labels in a representation such
as JSON that does not depend on specific characters being disallowed. Example:
\"environment\" : \"dev\" Read-write.", |
547 "type": "object" | 767 "type": "object" |
548 }, | 768 }, |
549 "done": { | 769 "parent": { |
550 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed, and either `error
` or `response` is available.", | 770 "$ref": "ResourceId", |
551 "type": "boolean" | 771 "description": "An optional reference to a parent Resource.
The only supported parent type is \"organization\". Once set, the parent cannot
be modified. Read-write." |
552 }, | |
553 "error": { | |
554 "$ref": "Status", | |
555 "description": "The error result of the operation in case of
failure." | |
556 }, | |
557 "response": { | |
558 "additionalProperties": { | |
559 "description": "Properties of the object. Contains field
@ype with type URL.", | |
560 "type": "any" | |
561 }, | |
562 "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 `G
et`/`Create`/`Update`, the response should be the resource. For other methods, t
he response should have the type `XxxResponse`, where `Xxx` is the original meth
od name. For example, if the original method name is `TakeSnapshot()`, the infer
red response type is `TakeSnapshotResponse`.", | |
563 "type": "object" | |
564 } | 772 } |
565 }, | 773 }, |
566 "type": "object" | 774 "type": "object" |
567 }, | 775 }, |
568 "Status": { | 776 "ResourceId": { |
569 "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). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of google.rpc.Code, but it may accept additional error codes if needed. Th
e error message should be a developer-facing English message that helps develope
rs *understand* and *resolve* the error. If a localized user-facing error messag
e is needed, put the localized message in the error details or localize it in th
e client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.r
pc` which can be used for common error conditions. # Language mapping The `Statu
s` message is the logical representation of the error model, but it is not neces
sarily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. Fo
r example, it will likely be mapped to some exceptions in Java, but more likely
mapped to some error codes in C. # Other uses The error model and the `Status` m
essage can be used in a variety of environments, either with or without APIs, to
provide a consistent developer experience across different environments. Exampl
e uses of this error model include: - Partial errors. If a service needs to retu
rn partial errors to the client, it may embed the `Status` in the normal respons
e to indicate the partial errors. - Workflow errors. A typical workflow has mult
iple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Statu
s` message should be used directly inside batch response, one for each error sub
-response. - Asynchronous operations. If an API call embeds asynchronous operati
on results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored i
n logs, the message `Status` could be used directly after any stripping needed f
or security/privacy reasons.", | 777 "description": "A container to reference an id for any resource type
. A `resource` in Google Cloud Platform is a generic term for something you (a d
eveloper) may want to interact with through one of our API's. Some examples are
an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on.", |
570 "id": "Status", | 778 "id": "ResourceId", |
571 "properties": { | 779 "properties": { |
572 "code": { | 780 "type": { |
573 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 781 "description": "Required field representing the resource typ
e this id is for. At present, the only valid type is \"organization\".", |
574 "format": "int32", | |
575 "type": "integer" | |
576 }, | |
577 "message": { | |
578 "description": "A developer-facing error message, which shou
ld 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.", | |
579 "type": "string" | 782 "type": "string" |
580 }, | 783 }, |
581 "details": { | 784 "id": { |
582 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", | 785 "description": "Required field for the type-specific id. Thi
s should correspond to the id used in the type-specific API's.", |
583 "items": { | 786 "type": "string" |
584 "additionalProperties": { | |
585 "description": "Properties of the object. Contains f
ield @ype with type URL.", | |
586 "type": "any" | |
587 }, | |
588 "type": "object" | |
589 }, | |
590 "type": "array" | |
591 } | 787 } |
592 }, | 788 }, |
593 "type": "object" | 789 "type": "object" |
| 790 }, |
| 791 "ListProjectsResponse": { |
| 792 "description": "A page of the response received from the ListProject
s method. A paginated response where more pages are available has `next_page_tok
en` set. This token can be used in a subsequent request to retrieve the next req
uest page.", |
| 793 "id": "ListProjectsResponse", |
| 794 "properties": { |
| 795 "projects": { |
| 796 "description": "The list of Projects that matched the list f
ilter. This list can be paginated.", |
| 797 "items": { |
| 798 "$ref": "Project" |
| 799 }, |
| 800 "type": "array" |
| 801 }, |
| 802 "nextPageToken": { |
| 803 "description": "Pagination token. If the result set is too l
arge to fit in a single response, this token is returned. It encodes the positio
n of the current result cursor. Feeding this value into a new list request with
the `page_token` parameter gives the next page of the results. When `next_page_t
oken` is not filled in, there is no next page and the list returned is the last
page in the result set. Pagination tokens have a limited lifetime.", |
| 804 "type": "string" |
| 805 } |
| 806 }, |
| 807 "type": "object" |
| 808 }, |
| 809 "Empty": { |
| 810 "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 re
presentation for `Empty` is empty JSON object `{}`.", |
| 811 "id": "Empty", |
| 812 "type": "object" |
| 813 }, |
| 814 "UndeleteProjectRequest": { |
| 815 "description": "The request sent to the UndeleteProject method.", |
| 816 "id": "UndeleteProjectRequest", |
| 817 "type": "object" |
| 818 }, |
| 819 "ProjectCreationStatus": { |
| 820 "description": "A status object which is used as the `metadata` fiel
d for the Operation returned by CreateProject. It provides insight for when sign
ificant phases of Project creation have completed.", |
| 821 "id": "ProjectCreationStatus", |
| 822 "properties": { |
| 823 "createTime": { |
| 824 "description": "Creation time of the project creation workfl
ow.", |
| 825 "type": "string" |
| 826 }, |
| 827 "gettable": { |
| 828 "description": "True if the project can be retrieved using G
etProject. No other operations on the project are guaranteed to work until the p
roject creation is complete.", |
| 829 "type": "boolean" |
| 830 }, |
| 831 "ready": { |
| 832 "description": "True if the project creation process is comp
lete.", |
| 833 "type": "boolean" |
| 834 } |
| 835 }, |
| 836 "type": "object" |
| 837 }, |
| 838 "FolderOperation": { |
| 839 "description": "Metadata describing a long running folder operation"
, |
| 840 "id": "FolderOperation", |
| 841 "properties": { |
| 842 "displayName": { |
| 843 "description": "The display name of the folder.", |
| 844 "type": "string" |
| 845 }, |
| 846 "operationType": { |
| 847 "description": "The type of this operation.", |
| 848 "enum": [ |
| 849 "OPERATION_TYPE_UNSPECIFIED", |
| 850 "CREATE", |
| 851 "MOVE" |
| 852 ], |
| 853 "type": "string" |
| 854 }, |
| 855 "sourceParent": { |
| 856 "description": "The resource name of the folder's parent. On
ly applicable when the operation_type is MOVE.", |
| 857 "type": "string" |
| 858 }, |
| 859 "destinationParent": { |
| 860 "description": "The resource name of the folder or organizat
ion we are either creating the folder under or moving the folder to.", |
| 861 "type": "string" |
| 862 } |
| 863 }, |
| 864 "type": "object" |
| 865 }, |
| 866 "FolderOperationError": { |
| 867 "description": "A classification of the Folder Operation error.", |
| 868 "id": "FolderOperationError", |
| 869 "properties": { |
| 870 "errorMessageId": { |
| 871 "description": "The type of operation error experienced.", |
| 872 "enum": [ |
| 873 "ERROR_TYPE_UNSPECIFIED", |
| 874 "FOLDER_HEIGHT_VIOLATION", |
| 875 "MAX_CHILD_FOLDERS_VIOLATION", |
| 876 "FOLDER_NAME_UNIQUENESS_VIOLATION", |
| 877 "RESOURCE_DELETED", |
| 878 "PARENT_DELETED", |
| 879 "CYCLE_INTRODUCED_ERROR", |
| 880 "FOLDER_ALREADY_BEING_MOVED", |
| 881 "FOLDER_TO_DELETE_NON_EMPTY" |
| 882 ], |
| 883 "type": "string" |
| 884 } |
| 885 }, |
| 886 "type": "object" |
594 } | 887 } |
595 }, | 888 }, |
596 "servicePath": "", | 889 "servicePath": "", |
597 "title": "Google Cloud Resource Manager API", | 890 "title": "Google Cloud Resource Manager API", |
598 "version": "v1" | 891 "version": "v1" |
599 } | 892 } |
OLD | NEW |