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/KWbv1ck4Hir_ldCgHUUAxKHck4c\"", | |
22 "icons": { | 21 "icons": { |
23 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
24 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
25 }, | 24 }, |
26 "id": "cloudresourcemanager:v1", | 25 "id": "cloudresourcemanager:v1", |
27 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
28 "name": "cloudresourcemanager", | 27 "name": "cloudresourcemanager", |
29 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
30 "ownerName": "Google", | 29 "ownerName": "Google", |
31 "parameters": { | 30 "parameters": { |
32 "access_token": { | 31 "access_token": { |
33 "description": "OAuth access token.", | 32 "description": "OAuth access token.", |
34 "location": "query", | 33 "location": "query", |
35 "type": "string" | 34 "type": "string" |
36 }, | 35 }, |
| 36 "prettyPrint": { |
| 37 "default": "true", |
| 38 "description": "Returns response with indentations and line breaks."
, |
| 39 "location": "query", |
| 40 "type": "boolean" |
| 41 }, |
| 42 "key": { |
| 43 "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.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "quotaUser": { |
| 48 "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.", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "pp": { |
| 53 "default": "true", |
| 54 "description": "Pretty-print response.", |
| 55 "location": "query", |
| 56 "type": "boolean" |
| 57 }, |
| 58 "fields": { |
| 59 "description": "Selector specifying which fields to include in a par
tial response.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 }, |
37 "alt": { | 63 "alt": { |
38 "default": "json", | 64 "default": "json", |
39 "description": "Data format for response.", | 65 "description": "Data format for response.", |
| 66 "enum": [ |
| 67 "json", |
| 68 "media", |
| 69 "proto" |
| 70 ], |
40 "enumDescriptions": [ | 71 "enumDescriptions": [ |
41 "Responses with Content-Type of application/json", | 72 "Responses with Content-Type of application/json", |
42 "Media download with context-dependent Content-Type", | 73 "Media download with context-dependent Content-Type", |
43 "Responses with Content-Type of application/x-protobuf" | 74 "Responses with Content-Type of application/x-protobuf" |
44 ], | 75 ], |
45 "location": "query", | 76 "location": "query", |
46 "type": "string" | 77 "type": "string" |
47 }, | 78 }, |
48 "bearer_token": { | 79 "$.xgafv": { |
49 "description": "OAuth bearer token.", | 80 "description": "V1 error format.", |
| 81 "enum": [ |
| 82 "1", |
| 83 "2" |
| 84 ], |
| 85 "enumDescriptions": [ |
| 86 "v1 error format", |
| 87 "v2 error format" |
| 88 ], |
50 "location": "query", | 89 "location": "query", |
51 "type": "string" | 90 "type": "string" |
52 }, | 91 }, |
53 "callback": { | 92 "callback": { |
54 "description": "JSONP", | 93 "description": "JSONP", |
55 "location": "query", | 94 "location": "query", |
56 "type": "string" | 95 "type": "string" |
57 }, | 96 }, |
58 "fields": { | |
59 "description": "Selector specifying which fields to include in a par
tial response.", | |
60 "location": "query", | |
61 "type": "string" | |
62 }, | |
63 "key": { | |
64 "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.", | |
65 "location": "query", | |
66 "type": "string" | |
67 }, | |
68 "oauth_token": { | 97 "oauth_token": { |
69 "description": "OAuth 2.0 token for the current user.", | 98 "description": "OAuth 2.0 token for the current user.", |
70 "location": "query", | 99 "location": "query", |
71 "type": "string" | 100 "type": "string" |
72 }, | 101 }, |
73 "pp": { | 102 "uploadType": { |
74 "default": "true", | 103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
75 "description": "Pretty-print response.", | |
76 "location": "query", | |
77 "type": "boolean" | |
78 }, | |
79 "prettyPrint": { | |
80 "default": "true", | |
81 "description": "Returns response with indentations and line breaks."
, | |
82 "location": "query", | |
83 "type": "boolean" | |
84 }, | |
85 "quotaUser": { | |
86 "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.", | |
87 "location": "query", | 104 "location": "query", |
88 "type": "string" | 105 "type": "string" |
89 }, | 106 }, |
| 107 "bearer_token": { |
| 108 "description": "OAuth bearer token.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
90 "upload_protocol": { | 112 "upload_protocol": { |
91 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
92 "location": "query", | 114 "location": "query", |
93 "type": "string" | 115 "type": "string" |
94 }, | |
95 "uploadType": { | |
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
97 "location": "query", | |
98 "type": "string" | |
99 }, | |
100 "$.xgafv": { | |
101 "description": "V1 error format.", | |
102 "enumDescriptions": [ | |
103 "v1 error format", | |
104 "v2 error format" | |
105 ], | |
106 "location": "query", | |
107 "type": "string" | |
108 } | 116 } |
109 }, | 117 }, |
110 "protocol": "rest", | 118 "protocol": "rest", |
111 "resources": { | 119 "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": { | 120 "organizations": { |
142 "methods": { | 121 "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": { | 122 "get": { |
160 "description": "Fetches an Organization resource identified
by the specified resource name.", | 123 "description": "Fetches an Organization resource identified
by the specified resource name.", |
161 "httpMethod": "GET", | 124 "httpMethod": "GET", |
162 "id": "cloudresourcemanager.organizations.get", | 125 "id": "cloudresourcemanager.organizations.get", |
163 "parameterOrder": [ | 126 "parameterOrder": [ |
164 "name" | 127 "name" |
165 ], | 128 ], |
166 "parameters": { | 129 "parameters": { |
167 "name": { | 130 "name": { |
168 "description": "The resource name of the Organizatio
n to fetch, e.g. \"organizations/1234\".", | 131 "description": "The resource name of the Organizatio
n to fetch, e.g. \"organizations/1234\".", |
169 "location": "path", | 132 "location": "path", |
170 "pattern": "^organizations/[^/]*$", | 133 "pattern": "^organizations/[^/]+$", |
171 "required": true, | 134 "required": true, |
172 "type": "string" | 135 "type": "string" |
173 } | 136 } |
174 }, | 137 }, |
175 "path": "v1/{+name}", | 138 "path": "v1/{+name}", |
176 "response": { | 139 "response": { |
177 "$ref": "Organization" | 140 "$ref": "Organization" |
178 }, | 141 }, |
179 "scopes": [ | 142 "scopes": [ |
180 "https://www.googleapis.com/auth/cloud-platform", | 143 "https://www.googleapis.com/auth/cloud-platform", |
| 144 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 145 ] |
| 146 }, |
| 147 "testIamPermissions": { |
| 148 "description": "Returns permissions that a caller has on the
specified Organization.\nThe `resource` field should be the organization's reso
urce name,\ne.g. \"organizations/123\".", |
| 149 "httpMethod": "POST", |
| 150 "id": "cloudresourcemanager.organizations.testIamPermissions
", |
| 151 "parameterOrder": [ |
| 152 "resource" |
| 153 ], |
| 154 "parameters": { |
| 155 "resource": { |
| 156 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", |
| 157 "location": "path", |
| 158 "pattern": "^organizations/[^/]+$", |
| 159 "required": true, |
| 160 "type": "string" |
| 161 } |
| 162 }, |
| 163 "path": "v1/{+resource}:testIamPermissions", |
| 164 "request": { |
| 165 "$ref": "TestIamPermissionsRequest" |
| 166 }, |
| 167 "response": { |
| 168 "$ref": "TestIamPermissionsResponse" |
| 169 }, |
| 170 "scopes": [ |
| 171 "https://www.googleapis.com/auth/cloud-platform", |
| 172 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 173 ] |
| 174 }, |
| 175 "search": { |
| 176 "description": "Searches Organization resources that are vis
ible to the user and satisfy\nthe specified filter. This method returns Organiza
tions in an unspecified\norder. New Organizations do not necessarily appear at t
he end of the\nresults.", |
| 177 "httpMethod": "POST", |
| 178 "id": "cloudresourcemanager.organizations.search", |
| 179 "parameterOrder": [], |
| 180 "parameters": {}, |
| 181 "path": "v1/organizations:search", |
| 182 "request": { |
| 183 "$ref": "SearchOrganizationsRequest" |
| 184 }, |
| 185 "response": { |
| 186 "$ref": "SearchOrganizationsResponse" |
| 187 }, |
| 188 "scopes": [ |
| 189 "https://www.googleapis.com/auth/cloud-platform", |
181 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 190 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
182 ] | 191 ] |
183 }, | 192 }, |
184 "setIamPolicy": { | 193 "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\".", | 194 "description": "Sets the access control policy on an Organiz
ation resource. Replaces any\nexisting policy. The `resource` field should be th
e organization's resource\nname, e.g. \"organizations/123\".", |
186 "httpMethod": "POST", | 195 "httpMethod": "POST", |
187 "id": "cloudresourcemanager.organizations.setIamPolicy", | 196 "id": "cloudresourcemanager.organizations.setIamPolicy", |
188 "parameterOrder": [ | 197 "parameterOrder": [ |
189 "resource" | 198 "resource" |
190 ], | 199 ], |
191 "parameters": { | 200 "parameters": { |
192 "resource": { | 201 "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}`.", | 202 "description": "REQUIRED: The resource for which the
policy is being specified.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
194 "location": "path", | 203 "location": "path", |
195 "pattern": "^organizations/[^/]*$", | 204 "pattern": "^organizations/[^/]+$", |
196 "required": true, | 205 "required": true, |
197 "type": "string" | 206 "type": "string" |
198 } | 207 } |
199 }, | 208 }, |
200 "path": "v1/{+resource}:setIamPolicy", | 209 "path": "v1/{+resource}:setIamPolicy", |
201 "request": { | 210 "request": { |
202 "$ref": "SetIamPolicyRequest" | 211 "$ref": "SetIamPolicyRequest" |
203 }, | 212 }, |
204 "response": { | 213 "response": { |
205 "$ref": "Policy" | 214 "$ref": "Policy" |
206 }, | 215 }, |
207 "scopes": [ | 216 "scopes": [ |
208 "https://www.googleapis.com/auth/cloud-platform" | 217 "https://www.googleapis.com/auth/cloud-platform" |
209 ] | 218 ] |
210 }, | 219 }, |
211 "getIamPolicy": { | 220 "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\".
", | 221 "description": "Gets the access control policy for an Organi
zation resource. May be empty\nif no such policy or resource exists. The `resour
ce` field should be the\norganization's resource name, e.g. \"organizations/123\
".", |
213 "httpMethod": "POST", | 222 "httpMethod": "POST", |
214 "id": "cloudresourcemanager.organizations.getIamPolicy", | 223 "id": "cloudresourcemanager.organizations.getIamPolicy", |
215 "parameterOrder": [ | 224 "parameterOrder": [ |
216 "resource" | 225 "resource" |
217 ], | 226 ], |
218 "parameters": { | 227 "parameters": { |
219 "resource": { | 228 "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}`.", | 229 "description": "REQUIRED: The resource for which the
policy is being requested.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
221 "location": "path", | 230 "location": "path", |
222 "pattern": "^organizations/[^/]*$", | 231 "pattern": "^organizations/[^/]+$", |
223 "required": true, | 232 "required": true, |
224 "type": "string" | 233 "type": "string" |
225 } | 234 } |
226 }, | 235 }, |
227 "path": "v1/{+resource}:getIamPolicy", | 236 "path": "v1/{+resource}:getIamPolicy", |
228 "request": { | 237 "request": { |
229 "$ref": "GetIamPolicyRequest" | 238 "$ref": "GetIamPolicyRequest" |
230 }, | 239 }, |
231 "response": { | 240 "response": { |
232 "$ref": "Policy" | 241 "$ref": "Policy" |
233 }, | 242 }, |
234 "scopes": [ | 243 "scopes": [ |
235 "https://www.googleapis.com/auth/cloud-platform", | 244 "https://www.googleapis.com/auth/cloud-platform", |
236 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 245 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
237 ] | 246 ] |
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 } | 247 } |
267 } | 248 } |
268 }, | 249 }, |
269 "projects": { | 250 "projects": { |
270 "methods": { | 251 "methods": { |
271 "get": { | 252 "getAncestry": { |
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.", | 253 "description": "Gets a list of ancestors in the resource hie
rarchy for the Project\nidentified by the specified `project_id` (for example, `
my-project-123`).\n\nThe caller must have read permissions for this Project.", |
273 "httpMethod": "GET", | 254 "httpMethod": "POST", |
274 "id": "cloudresourcemanager.projects.get", | 255 "id": "cloudresourcemanager.projects.getAncestry", |
275 "parameterOrder": [ | 256 "parameterOrder": [ |
276 "projectId" | 257 "projectId" |
277 ], | 258 ], |
278 "parameters": { | 259 "parameters": { |
279 "projectId": { | 260 "projectId": { |
280 "description": "The Project ID (for example, `my-pro
ject-123`). Required.", | 261 "description": "The Project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
281 "location": "path", | 262 "location": "path", |
282 "required": true, | 263 "required": true, |
283 "type": "string" | 264 "type": "string" |
284 } | 265 } |
285 }, | 266 }, |
286 "path": "v1/projects/{projectId}", | 267 "path": "v1/projects/{projectId}:getAncestry", |
| 268 "request": { |
| 269 "$ref": "GetAncestryRequest" |
| 270 }, |
287 "response": { | 271 "response": { |
288 "$ref": "Project" | 272 "$ref": "GetAncestryResponse" |
289 }, | 273 }, |
290 "scopes": [ | 274 "scopes": [ |
291 "https://www.googleapis.com/auth/cloud-platform", | 275 "https://www.googleapis.com/auth/cloud-platform", |
292 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 276 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
293 ] | 277 ] |
294 }, | 278 }, |
| 279 "getIamPolicy": { |
| 280 "description": "Returns the IAM access control policy for th
e specified Project.\nPermission is denied if the policy or the resource does no
t exist.", |
| 281 "httpMethod": "POST", |
| 282 "id": "cloudresourcemanager.projects.getIamPolicy", |
| 283 "parameterOrder": [ |
| 284 "resource" |
| 285 ], |
| 286 "parameters": { |
| 287 "resource": { |
| 288 "description": "REQUIRED: The resource for which the
policy is being requested.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
| 289 "location": "path", |
| 290 "required": true, |
| 291 "type": "string" |
| 292 } |
| 293 }, |
| 294 "path": "v1/projects/{resource}:getIamPolicy", |
| 295 "request": { |
| 296 "$ref": "GetIamPolicyRequest" |
| 297 }, |
| 298 "response": { |
| 299 "$ref": "Policy" |
| 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": "Restores the Project identified by the speci
fied\n`project_id` (for example, `my-project-123`).\nYou can only use this metho
d for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion
starts, the Project cannot be restored.\n\nThe caller must have modify permissi
ons for this Project.", |
| 308 "httpMethod": "POST", |
| 309 "id": "cloudresourcemanager.projects.undelete", |
| 310 "parameterOrder": [ |
| 311 "projectId" |
| 312 ], |
| 313 "parameters": { |
| 314 "projectId": { |
| 315 "description": "The project ID (for example, `foo-ba
r-123`).\n\nRequired.", |
| 316 "location": "path", |
| 317 "required": true, |
| 318 "type": "string" |
| 319 } |
| 320 }, |
| 321 "path": "v1/projects/{projectId}:undelete", |
| 322 "request": { |
| 323 "$ref": "UndeleteProjectRequest" |
| 324 }, |
| 325 "response": { |
| 326 "$ref": "Empty" |
| 327 }, |
| 328 "scopes": [ |
| 329 "https://www.googleapis.com/auth/cloud-platform" |
| 330 ] |
| 331 }, |
295 "list": { | 332 "list": { |
296 "description": "Lists Projects that are visible to the user
and satisfy the specified filter. This method returns Projects in an unspecified
order. New Projects do not necessarily appear at the end of the list.", | 333 "description": "Lists Projects that are visible to the user
and satisfy the\nspecified filter. This method returns Projects in an unspecifie
d order.\nNew Projects do not necessarily appear at the end of the list.", |
297 "httpMethod": "GET", | 334 "httpMethod": "GET", |
298 "id": "cloudresourcemanager.projects.list", | 335 "id": "cloudresourcemanager.projects.list", |
| 336 "parameterOrder": [], |
299 "parameters": { | 337 "parameters": { |
300 "pageToken": { | |
301 "description": "A pagination token returned from a p
revious call to ListProjects that indicates from where listing should continue.
Optional.", | |
302 "location": "query", | |
303 "type": "string" | |
304 }, | |
305 "pageSize": { | 338 "pageSize": { |
306 "description": "The maximum number of Projects to re
turn in the response. The server can return fewer Projects than requested. If un
specified, server picks an appropriate default. Optional.", | 339 "description": "The maximum number of Projects to re
turn in the response.\nThe server can return fewer Projects than requested.\nIf
unspecified, server picks an appropriate default.\n\nOptional.", |
307 "format": "int32", | 340 "format": "int32", |
308 "location": "query", | 341 "location": "query", |
309 "type": "integer" | 342 "type": "integer" |
310 }, | 343 }, |
311 "filter": { | 344 "filter": { |
312 "description": "An expression for filtering the resu
lts of the request. Filter rules are case insensitive. The fields eligible for f
iltering are: + `name` + `id` + labels.key where *key* is the name of a label So
me examples of using labels as filters: |Filter|Description| |------|-----------
| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `h
owl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels
.color:*|The project has the label `color`.| |labels.color:red|The project's lab
el `color` has the value `red`.| |labels.color:red label.size:big|The project's
label `color` has the value `red` and its label `size` has the value `big`. Opti
onal.", | 345 "description": "An expression for filtering the resu
lts of the request. Filter rules are\ncase insensitive. The fields eligible for
filtering are:\n\n+ `name`\n+ `id`\n+ <code>labels.<em>key</em></code> where *k
ey* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filt
er|Description|\n|------|-----------|\n|name:*|The project has a name.|\n|name:H
owl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n
|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `col
or`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|lab
els.color:red label.size:big|The project's label `color` has the\nvalue `re
d` and its label `size` has the value `big`.\n\nOptional.", |
| 346 "location": "query", |
| 347 "type": "string" |
| 348 }, |
| 349 "pageToken": { |
| 350 "description": "A pagination token returned from a p
revious call to ListProjects\nthat indicates from where listing should continue.
\n\nOptional.", |
313 "location": "query", | 351 "location": "query", |
314 "type": "string" | 352 "type": "string" |
315 } | 353 } |
316 }, | 354 }, |
317 "path": "v1/projects", | 355 "path": "v1/projects", |
318 "response": { | 356 "response": { |
319 "$ref": "ListProjectsResponse" | 357 "$ref": "ListProjectsResponse" |
320 }, | 358 }, |
321 "scopes": [ | 359 "scopes": [ |
322 "https://www.googleapis.com/auth/cloud-platform", | 360 "https://www.googleapis.com/auth/cloud-platform", |
323 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 361 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
324 ] | 362 ] |
325 }, | 363 }, |
326 "create": { | 364 "get": { |
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.", | 365 "description": "Retrieves the Project identified by the spec
ified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have rea
d permissions for this Project.", |
328 "httpMethod": "POST", | 366 "httpMethod": "GET", |
329 "id": "cloudresourcemanager.projects.create", | 367 "id": "cloudresourcemanager.projects.get", |
330 "path": "v1/projects", | 368 "parameterOrder": [ |
331 "request": { | 369 "projectId" |
| 370 ], |
| 371 "parameters": { |
| 372 "projectId": { |
| 373 "description": "The Project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
| 374 "location": "path", |
| 375 "required": true, |
| 376 "type": "string" |
| 377 } |
| 378 }, |
| 379 "path": "v1/projects/{projectId}", |
| 380 "response": { |
332 "$ref": "Project" | 381 "$ref": "Project" |
333 }, | 382 }, |
334 "response": { | |
335 "$ref": "Operation" | |
336 }, | |
337 "scopes": [ | 383 "scopes": [ |
338 "https://www.googleapis.com/auth/cloud-platform" | 384 "https://www.googleapis.com/auth/cloud-platform", |
| 385 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
339 ] | 386 ] |
340 }, | 387 }, |
341 "update": { | 388 "update": { |
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.", | 389 "description": "Updates the attributes of the Project identi
fied by the specified\n`project_id` (for example, `my-project-123`).\n\nThe call
er must have modify permissions for this Project.", |
343 "httpMethod": "PUT", | 390 "httpMethod": "PUT", |
344 "id": "cloudresourcemanager.projects.update", | 391 "id": "cloudresourcemanager.projects.update", |
345 "parameterOrder": [ | 392 "parameterOrder": [ |
346 "projectId" | 393 "projectId" |
347 ], | 394 ], |
348 "parameters": { | 395 "parameters": { |
349 "projectId": { | 396 "projectId": { |
350 "description": "The project ID (for example, `my-pro
ject-123`). Required.", | 397 "description": "The project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
351 "location": "path", | 398 "location": "path", |
352 "required": true, | 399 "required": true, |
353 "type": "string" | 400 "type": "string" |
354 } | 401 } |
355 }, | 402 }, |
356 "path": "v1/projects/{projectId}", | 403 "path": "v1/projects/{projectId}", |
357 "request": { | 404 "request": { |
358 "$ref": "Project" | 405 "$ref": "Project" |
359 }, | 406 }, |
360 "response": { | 407 "response": { |
361 "$ref": "Project" | 408 "$ref": "Project" |
362 }, | 409 }, |
363 "scopes": [ | 410 "scopes": [ |
364 "https://www.googleapis.com/auth/cloud-platform" | 411 "https://www.googleapis.com/auth/cloud-platform" |
365 ] | 412 ] |
366 }, | 413 }, |
367 "delete": { | 414 "create": { |
368 "description": "Marks the Project identified by the specifie
d `project_id` (for example, `my-project-123`) for deletion. This method will on
ly affect the Project if the following criteria are met: + The Project does not
have a billing account associated with it. + The Project has a lifecycle state o
f ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELET
E_REQUESTED. The deletion starts at an unspecified time, at which point the Proj
ect is no longer accessible. Until the deletion completes, you can check the lif
ecycle state checked by retrieving the Project with GetProject, and the Project
remains visible to ListProjects. However, you cannot update the project. After t
he deletion completes, the Project is not retrievable by the GetProject and List
Projects methods. The caller must have modify permissions for this Project.", | 415 "description": "Request that a new Project be created. The r
esult is an Operation which\ncan be used to track the creation process. It is au
tomatically deleted\nafter a few hours, so there is no need to call DeleteOperat
ion.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\np
ercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency
. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th
second with an exponential backoff.", |
369 "httpMethod": "DELETE", | 416 "httpMethod": "POST", |
370 "id": "cloudresourcemanager.projects.delete", | 417 "id": "cloudresourcemanager.projects.create", |
371 "parameterOrder": [ | 418 "parameterOrder": [], |
372 "projectId" | 419 "parameters": {}, |
373 ], | 420 "path": "v1/projects", |
374 "parameters": { | 421 "request": { |
375 "projectId": { | 422 "$ref": "Project" |
376 "description": "The Project ID (for example, `foo-ba
r-123`). Required.", | |
377 "location": "path", | |
378 "required": true, | |
379 "type": "string" | |
380 } | |
381 }, | 423 }, |
382 "path": "v1/projects/{projectId}", | |
383 "response": { | 424 "response": { |
384 "$ref": "Empty" | 425 "$ref": "Operation" |
385 }, | 426 }, |
386 "scopes": [ | 427 "scopes": [ |
387 "https://www.googleapis.com/auth/cloud-platform" | 428 "https://www.googleapis.com/auth/cloud-platform" |
388 ] | 429 ] |
389 }, | 430 }, |
390 "undelete": { | |
391 "description": "Restores the Project identified by the speci
fied `project_id` (for example, `my-project-123`). You can only use this method
for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion sta
rts, the Project cannot be restored. The caller must have modify permissions for
this Project.", | |
392 "httpMethod": "POST", | |
393 "id": "cloudresourcemanager.projects.undelete", | |
394 "parameterOrder": [ | |
395 "projectId" | |
396 ], | |
397 "parameters": { | |
398 "projectId": { | |
399 "description": "The project ID (for example, `foo-ba
r-123`). Required.", | |
400 "location": "path", | |
401 "required": true, | |
402 "type": "string" | |
403 } | |
404 }, | |
405 "path": "v1/projects/{projectId}:undelete", | |
406 "request": { | |
407 "$ref": "UndeleteProjectRequest" | |
408 }, | |
409 "response": { | |
410 "$ref": "Empty" | |
411 }, | |
412 "scopes": [ | |
413 "https://www.googleapis.com/auth/cloud-platform" | |
414 ] | |
415 }, | |
416 "getIamPolicy": { | |
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.", | |
418 "httpMethod": "POST", | |
419 "id": "cloudresourcemanager.projects.getIamPolicy", | |
420 "parameterOrder": [ | |
421 "resource" | |
422 ], | |
423 "parameters": { | |
424 "resource": { | |
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}`.", | |
426 "location": "path", | |
427 "required": true, | |
428 "type": "string" | |
429 } | |
430 }, | |
431 "path": "v1/projects/{resource}:getIamPolicy", | |
432 "request": { | |
433 "$ref": "GetIamPolicyRequest" | |
434 }, | |
435 "response": { | |
436 "$ref": "Policy" | |
437 }, | |
438 "scopes": [ | |
439 "https://www.googleapis.com/auth/cloud-platform", | |
440 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
441 ] | |
442 }, | |
443 "setIamPolicy": { | 431 "setIamPolicy": { |
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.", | 432 "description": "Sets the IAM access control policy for the s
pecified Project. Replaces\nany existing policy.\n\nThe following constraints ap
ply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `a
llAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner
role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts
can be made owners of a project directly\nwithout any restrictions. However, to
be added as an owner, a user must be\ninvited via Cloud Platform console and mus
t accept the invitation.\n\n+ A user cannot be granted the owner role using `set
IamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform
Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant th
e owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only usi
ng the Cloud Platform Console.\n\n+ Membership changes that leave the project wi
thout any owners that have\naccepted the Terms of Service (ToS) will be rejected
.\n\n+ There must be at least one owner who has accepted the Terms of\nService (
ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last To
S-accepted owner from the policy will fail. This\nrestriction also applies to le
gacy projects that no longer have owners\nwho have accepted the ToS. Edits to IA
M policies will be rejected until\nthe lack of a ToS-accepting owner is rectifie
d.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote:
Removing service accounts from policies or changing their roles\ncan render ser
vices completely inoperable. It is important to understand\nhow the service acco
unt is being used before removing or updating its\nroles.", |
445 "httpMethod": "POST", | 433 "httpMethod": "POST", |
446 "id": "cloudresourcemanager.projects.setIamPolicy", | 434 "id": "cloudresourcemanager.projects.setIamPolicy", |
447 "parameterOrder": [ | 435 "parameterOrder": [ |
448 "resource" | 436 "resource" |
449 ], | 437 ], |
450 "parameters": { | 438 "parameters": { |
451 "resource": { | 439 "resource": { |
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}`.", | 440 "description": "REQUIRED: The resource for which the
policy is being specified.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
453 "location": "path", | 441 "location": "path", |
454 "required": true, | 442 "required": true, |
455 "type": "string" | 443 "type": "string" |
456 } | 444 } |
457 }, | 445 }, |
458 "path": "v1/projects/{resource}:setIamPolicy", | 446 "path": "v1/projects/{resource}:setIamPolicy", |
459 "request": { | 447 "request": { |
460 "$ref": "SetIamPolicyRequest" | 448 "$ref": "SetIamPolicyRequest" |
461 }, | 449 }, |
462 "response": { | 450 "response": { |
463 "$ref": "Policy" | 451 "$ref": "Policy" |
464 }, | 452 }, |
465 "scopes": [ | 453 "scopes": [ |
466 "https://www.googleapis.com/auth/cloud-platform" | 454 "https://www.googleapis.com/auth/cloud-platform" |
467 ] | 455 ] |
468 }, | 456 }, |
| 457 "delete": { |
| 458 "description": "Marks the Project identified by the specifie
d\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will
only affect the Project if the following criteria are met:\n\n+ The Project does
not have a billing account associated with it.\n+ The Project has a lifecycle s
tate of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTI
VE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which
point the Project is no longer accessible.\n\nUntil the deletion completes, you
can check the lifecycle state\nchecked by retrieving the Project with GetProject
,\nand the Project remains visible to ListProjects.\nHowever, you cannot update
the project.\n\nAfter the deletion completes, the Project is not retrievable by\
nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permi
ssions for this Project.", |
| 459 "httpMethod": "DELETE", |
| 460 "id": "cloudresourcemanager.projects.delete", |
| 461 "parameterOrder": [ |
| 462 "projectId" |
| 463 ], |
| 464 "parameters": { |
| 465 "projectId": { |
| 466 "description": "The Project ID (for example, `foo-ba
r-123`).\n\nRequired.", |
| 467 "location": "path", |
| 468 "required": true, |
| 469 "type": "string" |
| 470 } |
| 471 }, |
| 472 "path": "v1/projects/{projectId}", |
| 473 "response": { |
| 474 "$ref": "Empty" |
| 475 }, |
| 476 "scopes": [ |
| 477 "https://www.googleapis.com/auth/cloud-platform" |
| 478 ] |
| 479 }, |
469 "testIamPermissions": { | 480 "testIamPermissions": { |
470 "description": "Returns permissions that a caller has on the
specified Project.", | 481 "description": "Returns permissions that a caller has on the
specified Project.", |
471 "httpMethod": "POST", | 482 "httpMethod": "POST", |
472 "id": "cloudresourcemanager.projects.testIamPermissions", | 483 "id": "cloudresourcemanager.projects.testIamPermissions", |
473 "parameterOrder": [ | 484 "parameterOrder": [ |
474 "resource" | 485 "resource" |
475 ], | 486 ], |
476 "parameters": { | 487 "parameters": { |
477 "resource": { | 488 "resource": { |
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}`.", | 489 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", |
479 "location": "path", | 490 "location": "path", |
480 "required": true, | 491 "required": true, |
481 "type": "string" | 492 "type": "string" |
482 } | 493 } |
483 }, | 494 }, |
484 "path": "v1/projects/{resource}:testIamPermissions", | 495 "path": "v1/projects/{resource}:testIamPermissions", |
485 "request": { | 496 "request": { |
486 "$ref": "TestIamPermissionsRequest" | 497 "$ref": "TestIamPermissionsRequest" |
487 }, | 498 }, |
488 "response": { | 499 "response": { |
489 "$ref": "TestIamPermissionsResponse" | 500 "$ref": "TestIamPermissionsResponse" |
490 }, | 501 }, |
491 "scopes": [ | 502 "scopes": [ |
492 "https://www.googleapis.com/auth/cloud-platform", | 503 "https://www.googleapis.com/auth/cloud-platform", |
| 504 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 505 ] |
| 506 } |
| 507 } |
| 508 }, |
| 509 "operations": { |
| 510 "methods": { |
| 511 "get": { |
| 512 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
| 513 "httpMethod": "GET", |
| 514 "id": "cloudresourcemanager.operations.get", |
| 515 "parameterOrder": [ |
| 516 "name" |
| 517 ], |
| 518 "parameters": { |
| 519 "name": { |
| 520 "description": "The name of the operation resource."
, |
| 521 "location": "path", |
| 522 "pattern": "^operations/.+$", |
| 523 "required": true, |
| 524 "type": "string" |
| 525 } |
| 526 }, |
| 527 "path": "v1/{+name}", |
| 528 "response": { |
| 529 "$ref": "Operation" |
| 530 }, |
| 531 "scopes": [ |
| 532 "https://www.googleapis.com/auth/cloud-platform", |
493 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 533 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
494 ] | 534 ] |
495 } | 535 } |
496 } | 536 } |
497 } | 537 } |
498 }, | 538 }, |
499 "revision": "20160927", | 539 "revision": "20161207", |
500 "rootUrl": "https://cloudresourcemanager.googleapis.com/", | 540 "rootUrl": "https://cloudresourcemanager.googleapis.com/", |
501 "schemas": { | 541 "schemas": { |
502 "Operation": { | 542 "FolderOperationError": { |
503 "description": "This resource represents a long-running operation th
at is the result of a network API call.", | 543 "description": "A classification of the Folder Operation error.", |
504 "id": "Operation", | 544 "id": "FolderOperationError", |
505 "properties": { | 545 "properties": { |
506 "name": { | 546 "errorMessageId": { |
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`."
, | 547 "description": "The type of operation error experienced.", |
| 548 "enum": [ |
| 549 "ERROR_TYPE_UNSPECIFIED", |
| 550 "FOLDER_HEIGHT_VIOLATION", |
| 551 "MAX_CHILD_FOLDERS_VIOLATION", |
| 552 "FOLDER_NAME_UNIQUENESS_VIOLATION", |
| 553 "RESOURCE_DELETED", |
| 554 "PARENT_DELETED", |
| 555 "CYCLE_INTRODUCED_ERROR", |
| 556 "FOLDER_ALREADY_BEING_MOVED", |
| 557 "FOLDER_TO_DELETE_NON_EMPTY" |
| 558 ], |
| 559 "enumDescriptions": [ |
| 560 "The error type was unrecognized or unspecified.", |
| 561 "The attempted action would violate the max folder depth
constraint.", |
| 562 "The attempted action would violate the max child folder
s constraint.", |
| 563 "The attempted action would violate the locally-unique f
older\ndisplay_name constraint.", |
| 564 "The resource being moved has been deleted.", |
| 565 "The resource a folder was being added to has been delet
ed.", |
| 566 "The attempted action would introduce cycle in resource
path.", |
| 567 "The attempted action would move a folder that is alread
y being moved.", |
| 568 "The folder the caller is trying to delete contains acti
ve resources." |
| 569 ], |
508 "type": "string" | 570 "type": "string" |
509 }, | |
510 "metadata": { | |
511 "additionalProperties": { | |
512 "description": "Properties of the object. Contains field
@type with type URL.", | |
513 "type": "any" | |
514 }, | |
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.", | |
516 "type": "object" | |
517 }, | |
518 "done": { | |
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.", | |
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" | |
533 } | 571 } |
534 }, | 572 }, |
535 "type": "object" | 573 "type": "object" |
536 }, | 574 }, |
537 "Status": { | 575 "Status": { |
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.", | 576 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
539 "id": "Status", | 577 "id": "Status", |
540 "properties": { | 578 "properties": { |
541 "code": { | 579 "code": { |
542 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 580 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
543 "format": "int32", | 581 "format": "int32", |
544 "type": "integer" | 582 "type": "integer" |
545 }, | 583 }, |
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.", | |
548 "type": "string" | |
549 }, | |
550 "details": { | 584 "details": { |
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.", | 585 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
552 "items": { | 586 "items": { |
553 "additionalProperties": { | 587 "additionalProperties": { |
554 "description": "Properties of the object. Contains f
ield @type with type URL.", | 588 "description": "Properties of the object. Contains f
ield @type with type URL.", |
555 "type": "any" | 589 "type": "any" |
556 }, | 590 }, |
557 "type": "object" | 591 "type": "object" |
558 }, | 592 }, |
559 "type": "array" | 593 "type": "array" |
560 } | 594 }, |
561 }, | 595 "message": { |
562 "type": "object" | 596 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
563 }, | 597 "type": "string" |
564 "SearchOrganizationsRequest": { | 598 } |
565 "description": "The request sent to the `SearchOrganizations` method
.", | 599 }, |
566 "id": "SearchOrganizationsRequest", | 600 "type": "object" |
567 "properties": { | 601 }, |
568 "pageSize": { | 602 "ListProjectsResponse": { |
569 "description": "The maximum number of Organizations to retur
n in the response. This field is optional.", | 603 "description": "A page of the response received from the\nListProjec
ts\nmethod.\n\nA paginated response where more pages are available has\n`next_pa
ge_token` set. This token can be used in a subsequent request to\nretrieve the n
ext request page.", |
570 "format": "int32", | 604 "id": "ListProjectsResponse", |
571 "type": "integer" | 605 "properties": { |
572 }, | 606 "projects": { |
573 "pageToken": { | 607 "description": "The list of Projects that matched the list f
ilter. This list can\nbe paginated.", |
574 "description": "A pagination token returned from a previous
call to `SearchOrganizations` that indicates from where listing should continue.
This field is optional.", | 608 "items": { |
575 "type": "string" | 609 "$ref": "Project" |
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.", | |
579 "type": "string" | |
580 } | |
581 }, | |
582 "type": "object" | |
583 }, | |
584 "SearchOrganizationsResponse": { | |
585 "description": "The response returned from the `SearchOrganizations`
method.", | |
586 "id": "SearchOrganizationsResponse", | |
587 "properties": { | |
588 "organizations": { | |
589 "description": "The list of Organizations that matched the s
earch query, possibly paginated.", | |
590 "items": { | |
591 "$ref": "Organization" | |
592 }, | 610 }, |
593 "type": "array" | 611 "type": "array" |
594 }, | 612 }, |
595 "nextPageToken": { | 613 "nextPageToken": { |
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.", | 614 "description": "Pagination token.\n\nIf the result set is to
o large to fit in a single response, this token\nis returned. It encodes the pos
ition of the current result cursor.\nFeeding this value into a new list request
with the `page_token` parameter\ngives the next page of the results.\n\nWhen `ne
xt_page_token` is not filled in, there is no next page and\nthe list returned is
the last page in the result set.\n\nPagination tokens have a limited lifetime."
, |
597 "type": "string" | 615 "type": "string" |
| 616 } |
| 617 }, |
| 618 "type": "object" |
| 619 }, |
| 620 "UndeleteProjectRequest": { |
| 621 "description": "The request sent to the UndeleteProject\nmethod.", |
| 622 "id": "UndeleteProjectRequest", |
| 623 "properties": {}, |
| 624 "type": "object" |
| 625 }, |
| 626 "FolderOperation": { |
| 627 "description": "Metadata describing a long running folder operation"
, |
| 628 "id": "FolderOperation", |
| 629 "properties": { |
| 630 "displayName": { |
| 631 "description": "The display name of the folder.", |
| 632 "type": "string" |
| 633 }, |
| 634 "sourceParent": { |
| 635 "description": "The resource name of the folder's parent.\nO
nly applicable when the operation_type is MOVE.", |
| 636 "type": "string" |
| 637 }, |
| 638 "destinationParent": { |
| 639 "description": "The resource name of the folder or organizat
ion we are either creating\nthe folder under or moving the folder to.", |
| 640 "type": "string" |
| 641 }, |
| 642 "operationType": { |
| 643 "description": "The type of this operation.", |
| 644 "enum": [ |
| 645 "OPERATION_TYPE_UNSPECIFIED", |
| 646 "CREATE", |
| 647 "MOVE" |
| 648 ], |
| 649 "enumDescriptions": [ |
| 650 "Operation type not specified.", |
| 651 "A create folder operation.", |
| 652 "A move folder operation." |
| 653 ], |
| 654 "type": "string" |
| 655 } |
| 656 }, |
| 657 "type": "object" |
| 658 }, |
| 659 "Operation": { |
| 660 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 661 "id": "Operation", |
| 662 "properties": { |
| 663 "error": { |
| 664 "$ref": "Status", |
| 665 "description": "The error result of the operation in case of
failure or cancellation." |
| 666 }, |
| 667 "done": { |
| 668 "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.", |
| 669 "type": "boolean" |
| 670 }, |
| 671 "metadata": { |
| 672 "additionalProperties": { |
| 673 "description": "Properties of the object. Contains field
@type with type URL.", |
| 674 "type": "any" |
| 675 }, |
| 676 "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.
", |
| 677 "type": "object" |
| 678 }, |
| 679 "response": { |
| 680 "additionalProperties": { |
| 681 "description": "Properties of the object. Contains field
@type with type URL.", |
| 682 "type": "any" |
| 683 }, |
| 684 "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`.", |
| 685 "type": "object" |
| 686 }, |
| 687 "name": { |
| 688 "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`
.", |
| 689 "type": "string" |
| 690 } |
| 691 }, |
| 692 "type": "object" |
| 693 }, |
| 694 "GetIamPolicyRequest": { |
| 695 "description": "Request message for `GetIamPolicy` method.", |
| 696 "id": "GetIamPolicyRequest", |
| 697 "properties": {}, |
| 698 "type": "object" |
| 699 }, |
| 700 "SetIamPolicyRequest": { |
| 701 "description": "Request message for `SetIamPolicy` method.", |
| 702 "id": "SetIamPolicyRequest", |
| 703 "properties": { |
| 704 "policy": { |
| 705 "$ref": "Policy", |
| 706 "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." |
| 707 } |
| 708 }, |
| 709 "type": "object" |
| 710 }, |
| 711 "TestIamPermissionsResponse": { |
| 712 "description": "Response message for `TestIamPermissions` method.", |
| 713 "id": "TestIamPermissionsResponse", |
| 714 "properties": { |
| 715 "permissions": { |
| 716 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 717 "items": { |
| 718 "type": "string" |
| 719 }, |
| 720 "type": "array" |
598 } | 721 } |
599 }, | 722 }, |
600 "type": "object" | 723 "type": "object" |
601 }, | 724 }, |
602 "Organization": { | 725 "Organization": { |
603 "description": "The root node in the resource hierarchy to which a p
articular entity's (e.g., company) resources belong.", | 726 "description": "The root node in the resource hierarchy to which a p
articular entity's\n(e.g., company) resources belong.", |
604 "id": "Organization", | 727 "id": "Organization", |
605 "properties": { | 728 "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": { | 729 "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", | 730 "description": "A friendly string to be used to refer to the
Organization in the UI.\nAssigned by the server, set to the firm name of the Go
ogle For Work\ncustomer that owns this organization.\n@OutputOnly", |
| 731 "type": "string" |
| 732 }, |
| 733 "creationTime": { |
| 734 "description": "Timestamp when the Organization was created.
Assigned by the server.\n@OutputOnly", |
| 735 "format": "google-datetime", |
612 "type": "string" | 736 "type": "string" |
613 }, | 737 }, |
614 "owner": { | 738 "owner": { |
615 "$ref": "OrganizationOwner", | 739 "$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." | 740 "description": "The owner of this Organization. The owner sh
ould be specified on\ncreation. Once set, it cannot be changed.\nThis field is r
equired." |
617 }, | |
618 "creationTime": { | |
619 "description": "Timestamp when the Organization was created.
Assigned by the server. @OutputOnly", | |
620 "type": "string" | |
621 }, | 741 }, |
622 "lifecycleState": { | 742 "lifecycleState": { |
623 "description": "The organization's current lifecycle state.
Assigned by the server. @OutputOnly", | 743 "description": "The organization's current lifecycle state.
Assigned by the server.\n@OutputOnly", |
624 "enum": [ | 744 "enum": [ |
625 "LIFECYCLE_STATE_UNSPECIFIED", | 745 "LIFECYCLE_STATE_UNSPECIFIED", |
626 "ACTIVE", | 746 "ACTIVE", |
627 "DELETE_REQUESTED" | 747 "DELETE_REQUESTED" |
628 ], | 748 ], |
629 "type": "string" | 749 "enumDescriptions": [ |
630 } | 750 "Unspecified state. This is only useful for distinguish
ing unset values.", |
631 }, | 751 "The normal and active state.", |
632 "type": "object" | 752 "The organization has been marked for deletion by the us
er." |
633 }, | 753 ], |
634 "OrganizationOwner": { | 754 "type": "string" |
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.", | 755 }, |
636 "id": "OrganizationOwner", | 756 "name": { |
637 "properties": { | 757 "description": "Output Only. The resource name of the organi
zation. This is the\norganization's relative path in the API. Its format is\n\"o
rganizations/[organization_id]\". For example, \"organizations/1234\".", |
638 "directoryCustomerId": { | 758 "type": "string" |
639 "description": "The Google for Work customer id used in the
Directory API.", | |
640 "type": "string" | |
641 } | |
642 }, | |
643 "type": "object" | |
644 }, | |
645 "SetIamPolicyRequest": { | |
646 "description": "Request message for `SetIamPolicy` method.", | |
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 } | 759 } |
653 }, | 760 }, |
654 "type": "object" | 761 "type": "object" |
655 }, | 762 }, |
656 "Policy": { | 763 "Policy": { |
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).", | 764 "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).", |
658 "id": "Policy", | 765 "id": "Policy", |
659 "properties": { | 766 "properties": { |
| 767 "bindings": { |
| 768 "description": "Associates a list of `members` to a `role`.\
nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with
no members will result in an error.", |
| 769 "items": { |
| 770 "$ref": "Binding" |
| 771 }, |
| 772 "type": "array" |
| 773 }, |
| 774 "etag": { |
| 775 "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.", |
| 776 "format": "byte", |
| 777 "type": "string" |
| 778 }, |
660 "version": { | 779 "version": { |
661 "description": "Version of the `Policy`. The default version
is 0.", | 780 "description": "Version of the `Policy`. The default version
is 0.", |
662 "format": "int32", | 781 "format": "int32", |
663 "type": "integer" | 782 "type": "integer" |
664 }, | 783 } |
665 "bindings": { | 784 }, |
666 "description": "Associates a list of `members` to a `role`.
Multiple `bindings` must not be specified for the same `role`. `bindings` with n
o members will result in an error.", | 785 "type": "object" |
667 "items": { | 786 }, |
668 "$ref": "Binding" | 787 "ProjectCreationStatus": { |
669 }, | 788 "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.", |
670 "type": "array" | 789 "id": "ProjectCreationStatus", |
671 }, | 790 "properties": { |
672 "etag": { | 791 "ready": { |
673 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help prevent simultaneous updates of a policy from overwriting
each other. It is strongly suggested that systems make use of the `etag` in the
read-modify-write cycle to perform policy updates in order to avoid race condit
ions: An `etag` is returned in the response to `getIamPolicy`, and systems are e
xpected to put that etag in the request to `setIamPolicy` to ensure that their c
hange will be applied to the same version of the policy. If no `etag` is provide
d in the call to `setIamPolicy`, then the existing policy is overwritten blindly
.", | 792 "description": "True if the project creation process is comp
lete.", |
674 "format": "byte", | 793 "type": "boolean" |
675 "type": "string" | 794 }, |
676 } | 795 "gettable": { |
677 }, | 796 "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.", |
678 "type": "object" | 797 "type": "boolean" |
679 }, | 798 }, |
680 "Binding": { | 799 "createTime": { |
681 "description": "Associates `members` with a `role`.", | 800 "description": "Creation time of the project creation workfl
ow.", |
682 "id": "Binding", | 801 "format": "google-datetime", |
683 "properties": { | 802 "type": "string" |
684 "role": { | 803 } |
685 "description": "Role that is assigned to `members`. For exam
ple, `roles/viewer`, `roles/editor`, or `roles/owner`. Required", | 804 }, |
686 "type": "string" | |
687 }, | |
688 "members": { | |
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`.", | |
690 "items": { | |
691 "type": "string" | |
692 }, | |
693 "type": "array" | |
694 } | |
695 }, | |
696 "type": "object" | |
697 }, | |
698 "GetIamPolicyRequest": { | |
699 "description": "Request message for `GetIamPolicy` method.", | |
700 "id": "GetIamPolicyRequest", | |
701 "type": "object" | 805 "type": "object" |
702 }, | 806 }, |
703 "TestIamPermissionsRequest": { | 807 "TestIamPermissionsRequest": { |
704 "description": "Request message for `TestIamPermissions` method.", | 808 "description": "Request message for `TestIamPermissions` method.", |
705 "id": "TestIamPermissionsRequest", | 809 "id": "TestIamPermissionsRequest", |
706 "properties": { | 810 "properties": { |
707 "permissions": { | 811 "permissions": { |
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).", | 812 "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).", |
709 "items": { | 813 "items": { |
710 "type": "string" | 814 "type": "string" |
711 }, | 815 }, |
712 "type": "array" | 816 "type": "array" |
713 } | 817 } |
714 }, | 818 }, |
715 "type": "object" | 819 "type": "object" |
716 }, | 820 }, |
717 "TestIamPermissionsResponse": { | 821 "GetAncestryRequest": { |
718 "description": "Response message for `TestIamPermissions` method.", | 822 "description": "The request sent to the\nGetAncestry\nmethod.", |
719 "id": "TestIamPermissionsResponse", | 823 "id": "GetAncestryRequest", |
| 824 "properties": {}, |
| 825 "type": "object" |
| 826 }, |
| 827 "GetAncestryResponse": { |
| 828 "description": "Response from the GetAncestry method.", |
| 829 "id": "GetAncestryResponse", |
720 "properties": { | 830 "properties": { |
721 "permissions": { | 831 "ancestor": { |
722 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is allowed.", | 832 "description": "Ancestors are ordered from bottom to top of
the resource hierarchy. The\nfirst ancestor is the project itself, followed by t
he project's parent,\netc.", |
723 "items": { | 833 "items": { |
724 "type": "string" | 834 "$ref": "Ancestor" |
725 }, | 835 }, |
726 "type": "array" | 836 "type": "array" |
727 } | 837 } |
728 }, | 838 }, |
729 "type": "object" | 839 "type": "object" |
730 }, | 840 }, |
| 841 "SearchOrganizationsResponse": { |
| 842 "description": "The response returned from the `SearchOrganizations`
method.", |
| 843 "id": "SearchOrganizationsResponse", |
| 844 "properties": { |
| 845 "organizations": { |
| 846 "description": "The list of Organizations that matched the s
earch query, possibly\npaginated.", |
| 847 "items": { |
| 848 "$ref": "Organization" |
| 849 }, |
| 850 "type": "array" |
| 851 }, |
| 852 "nextPageToken": { |
| 853 "description": "A pagination token to be used to retrieve th
e next page of results. If the\nresult is too large to fit within the page size
specified in the request,\nthis field will be set with a token that can be used
to fetch the next page\nof results. If this field is empty, it indicates that th
is response\ncontains the last page of results.", |
| 854 "type": "string" |
| 855 } |
| 856 }, |
| 857 "type": "object" |
| 858 }, |
| 859 "SearchOrganizationsRequest": { |
| 860 "description": "The request sent to the `SearchOrganizations` method
.", |
| 861 "id": "SearchOrganizationsRequest", |
| 862 "properties": { |
| 863 "pageSize": { |
| 864 "description": "The maximum number of Organizations to retur
n in the response.\nThis field is optional.", |
| 865 "format": "int32", |
| 866 "type": "integer" |
| 867 }, |
| 868 "filter": { |
| 869 "description": "An optional query string used to filter the
Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n
\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`,
where the domain is a Google for Work domain, for example:\n\n|Filter|Descriptio
n|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations wit
h\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Orga
nizations corresponding to the domain `google.com`.|\n\nThis field is optional."
, |
| 870 "type": "string" |
| 871 }, |
| 872 "pageToken": { |
| 873 "description": "A pagination token returned from a previous
call to `SearchOrganizations`\nthat indicates from where listing should continue
.\nThis field is optional.", |
| 874 "type": "string" |
| 875 } |
| 876 }, |
| 877 "type": "object" |
| 878 }, |
| 879 "Empty": { |
| 880 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 881 "id": "Empty", |
| 882 "properties": {}, |
| 883 "type": "object" |
| 884 }, |
| 885 "Ancestor": { |
| 886 "description": "Identifying information for a single ancestor of a p
roject.", |
| 887 "id": "Ancestor", |
| 888 "properties": { |
| 889 "resourceId": { |
| 890 "$ref": "ResourceId", |
| 891 "description": "Resource id of the ancestor." |
| 892 } |
| 893 }, |
| 894 "type": "object" |
| 895 }, |
| 896 "ResourceId": { |
| 897 "description": "A container to reference an id for any resource type
. A `resource` in Google\nCloud Platform is a generic term for something you (a
developer) may want to\ninteract with through one of our API's. Some examples ar
e an AppEngine app,\na Compute Engine instance, a Cloud SQL database, and so on.
", |
| 898 "id": "ResourceId", |
| 899 "properties": { |
| 900 "type": { |
| 901 "description": "Required field representing the resource typ
e this id is for.\nAt present, the only valid type is \"organization\".", |
| 902 "type": "string" |
| 903 }, |
| 904 "id": { |
| 905 "description": "Required field for the type-specific id. Thi
s should correspond to the id\nused in the type-specific API's.", |
| 906 "type": "string" |
| 907 } |
| 908 }, |
| 909 "type": "object" |
| 910 }, |
| 911 "Binding": { |
| 912 "description": "Associates `members` with a `role`.", |
| 913 "id": "Binding", |
| 914 "properties": { |
| 915 "members": { |
| 916 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe
nts all the\n users of that domain. For example, `google.com` or `example.com`
.\n\n", |
| 917 "items": { |
| 918 "type": "string" |
| 919 }, |
| 920 "type": "array" |
| 921 }, |
| 922 "role": { |
| 923 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 924 "type": "string" |
| 925 } |
| 926 }, |
| 927 "type": "object" |
| 928 }, |
731 "Project": { | 929 "Project": { |
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.", | 930 "description": "A Project is a high-level Google Cloud Platform enti
ty. It is a\ncontainer for ACLs, APIs, AppEngine Apps, VMs, and other\nGoogle C
loud Platform resources.", |
733 "id": "Project", | 931 "id": "Project", |
734 "properties": { | 932 "properties": { |
735 "projectNumber": { | 933 "parent": { |
736 "description": "The number uniquely identifying the project.
Example: 415104041262 Read-only.", | 934 "$ref": "ResourceId", |
737 "format": "int64", | 935 "description": "An optional reference to a parent Resource.\
n\nThe only supported parent type is \"organization\". Once set, the parent\ncan
not be modified.\n\nRead-write." |
738 "type": "string" | |
739 }, | 936 }, |
740 "projectId": { | 937 "labels": { |
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.", | 938 "additionalProperties": { |
742 "type": "string" | 939 "type": "string" |
| 940 }, |
| 941 "description": "The labels associated with this Project.\n\n
Label keys must be between 1 and 63 characters long and must conform\nto the fol
lowing regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel valu
es must be between 0 and 63 characters long and must conform\nto the regular exp
ression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels ca
n be associated with a given resource.\n\nClients should store labels in a repre
sentation such as JSON that does not\ndepend on specific characters being disall
owed.\n\nExample: <code>\"environment\" : \"dev\"</code>\n\nRead-write.", |
| 942 "type": "object" |
743 }, | 943 }, |
744 "lifecycleState": { | 944 "lifecycleState": { |
745 "description": "The Project lifecycle state. Read-only.", | 945 "description": "The Project lifecycle state.\n\nRead-only.", |
746 "enum": [ | 946 "enum": [ |
747 "LIFECYCLE_STATE_UNSPECIFIED", | 947 "LIFECYCLE_STATE_UNSPECIFIED", |
748 "ACTIVE", | 948 "ACTIVE", |
749 "DELETE_REQUESTED", | 949 "DELETE_REQUESTED", |
750 "DELETE_IN_PROGRESS" | 950 "DELETE_IN_PROGRESS" |
751 ], | 951 ], |
| 952 "enumDescriptions": [ |
| 953 "Unspecified state. This is only used/useful for distin
guishing\nunset values.", |
| 954 "The normal and active state.", |
| 955 "The project has been marked for deletion by the user\n(
by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can
generally be reversed by invoking UndeleteProject.", |
| 956 "This lifecycle state is no longer used and not returned
by the API." |
| 957 ], |
| 958 "type": "string" |
| 959 }, |
| 960 "createTime": { |
| 961 "description": "Creation time.\n\nRead-only.", |
| 962 "format": "google-datetime", |
752 "type": "string" | 963 "type": "string" |
753 }, | 964 }, |
754 "name": { | 965 "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.", | 966 "description": "The user-assigned display name of the Projec
t.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and upperc
ase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamatio
n point.\n\nExample: <code>My Project</code>\n\nRead-write.", |
756 "type": "string" | 967 "type": "string" |
757 }, | 968 }, |
758 "createTime": { | 969 "projectNumber": { |
759 "description": "Creation time. Read-only.", | 970 "description": "The number uniquely identifying the project.
\n\nExample: <code>415104041262</code>\n\nRead-only.", |
| 971 "format": "int64", |
760 "type": "string" | 972 "type": "string" |
761 }, | 973 }, |
762 "labels": { | 974 "projectId": { |
763 "additionalProperties": { | 975 "description": "The unique, user-assigned ID of the Project.
\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with
a letter.\nTrailing hyphens are prohibited.\n\nExample: <code>tokyo-rain-123</co
de>\n\nRead-only after creation.", |
764 "type": "string" | |
765 }, | |
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.", | |
767 "type": "object" | |
768 }, | |
769 "parent": { | |
770 "$ref": "ResourceId", | |
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." | |
772 } | |
773 }, | |
774 "type": "object" | |
775 }, | |
776 "ResourceId": { | |
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.", | |
778 "id": "ResourceId", | |
779 "properties": { | |
780 "type": { | |
781 "description": "Required field representing the resource typ
e this id is for. At present, the only valid type is \"organization\".", | |
782 "type": "string" | |
783 }, | |
784 "id": { | |
785 "description": "Required field for the type-specific id. Thi
s should correspond to the id used in the type-specific API's.", | |
786 "type": "string" | 976 "type": "string" |
787 } | 977 } |
788 }, | 978 }, |
789 "type": "object" | 979 "type": "object" |
790 }, | 980 }, |
791 "ListProjectsResponse": { | 981 "OrganizationOwner": { |
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.", | 982 "description": "The entity that owns an Organization. The lifetime o
f the Organization and\nall of its descendants are bound to the `OrganizationOwn
er`. If the\n`OrganizationOwner` is deleted, the Organization and all its descen
dants will\nbe deleted.", |
793 "id": "ListProjectsResponse", | 983 "id": "OrganizationOwner", |
794 "properties": { | 984 "properties": { |
795 "projects": { | 985 "directoryCustomerId": { |
796 "description": "The list of Projects that matched the list f
ilter. This list can be paginated.", | 986 "description": "The Google for Work customer id used in the
Directory API.", |
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" | 987 "type": "string" |
805 } | 988 } |
806 }, | 989 }, |
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" | 990 "type": "object" |
887 } | 991 } |
888 }, | 992 }, |
889 "servicePath": "", | 993 "servicePath": "", |
890 "title": "Google Cloud Resource Manager API", | 994 "title": "Google Cloud Resource Manager API", |
891 "version": "v1" | 995 "version": "v1" |
892 } | 996 } |
OLD | NEW |