OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
| 6 "description": "View your data across Google Cloud Platform
services" |
| 7 }, |
5 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | |
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { | |
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 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "cloudresourcemanager:v1", | 25 "id": "cloudresourcemanager:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "cloudresourcemanager", | 27 "name": "cloudresourcemanager", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "access_token": { | 31 "upload_protocol": { |
32 "description": "OAuth access token.", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 33 "location": "query", |
34 "type": "string" | 34 "type": "string" |
35 }, | 35 }, |
36 "prettyPrint": { | 36 "prettyPrint": { |
37 "default": "true", | 37 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 39 "location": "query", |
40 "type": "boolean" | 40 "type": "boolean" |
41 }, | 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": { | 42 "fields": { |
59 "description": "Selector specifying which fields to include in a par
tial response.", | 43 "description": "Selector specifying which fields to include in a par
tial response.", |
60 "location": "query", | 44 "location": "query", |
61 "type": "string" | 45 "type": "string" |
62 }, | 46 }, |
| 47 "uploadType": { |
| 48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "$.xgafv": { |
| 53 "description": "V1 error format.", |
| 54 "enum": [ |
| 55 "1", |
| 56 "2" |
| 57 ], |
| 58 "enumDescriptions": [ |
| 59 "v1 error format", |
| 60 "v2 error format" |
| 61 ], |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
| 65 "callback": { |
| 66 "description": "JSONP", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
63 "alt": { | 70 "alt": { |
64 "default": "json", | 71 "default": "json", |
65 "description": "Data format for response.", | 72 "description": "Data format for response.", |
66 "enum": [ | 73 "enum": [ |
67 "json", | 74 "json", |
68 "media", | 75 "media", |
69 "proto" | 76 "proto" |
70 ], | 77 ], |
71 "enumDescriptions": [ | 78 "enumDescriptions": [ |
72 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
73 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
74 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
75 ], | 82 ], |
76 "location": "query", | 83 "location": "query", |
77 "type": "string" | 84 "type": "string" |
78 }, | 85 }, |
79 "$.xgafv": { | 86 "key": { |
80 "description": "V1 error format.", | 87 "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.", |
81 "enum": [ | |
82 "1", | |
83 "2" | |
84 ], | |
85 "enumDescriptions": [ | |
86 "v1 error format", | |
87 "v2 error format" | |
88 ], | |
89 "location": "query", | 88 "location": "query", |
90 "type": "string" | 89 "type": "string" |
91 }, | 90 }, |
92 "callback": { | 91 "access_token": { |
93 "description": "JSONP", | 92 "description": "OAuth access token.", |
94 "location": "query", | 93 "location": "query", |
95 "type": "string" | 94 "type": "string" |
96 }, | 95 }, |
97 "oauth_token": { | 96 "quotaUser": { |
98 "description": "OAuth 2.0 token for the current user.", | 97 "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.", |
99 "location": "query", | 98 "location": "query", |
100 "type": "string" | 99 "type": "string" |
101 }, | 100 }, |
102 "uploadType": { | 101 "pp": { |
103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 102 "default": "true", |
| 103 "description": "Pretty-print response.", |
| 104 "location": "query", |
| 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
104 "location": "query", | 109 "location": "query", |
105 "type": "string" | 110 "type": "string" |
106 }, | 111 }, |
107 "bearer_token": { | 112 "bearer_token": { |
108 "description": "OAuth bearer token.", | 113 "description": "OAuth bearer token.", |
109 "location": "query", | 114 "location": "query", |
110 "type": "string" | 115 "type": "string" |
111 }, | |
112 "upload_protocol": { | |
113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "organizations": { | 120 "organizations": { |
121 "methods": { | 121 "methods": { |
122 "get": { | |
123 "description": "Fetches an Organization resource identified
by the specified resource name.", | |
124 "httpMethod": "GET", | |
125 "id": "cloudresourcemanager.organizations.get", | |
126 "parameterOrder": [ | |
127 "name" | |
128 ], | |
129 "parameters": { | |
130 "name": { | |
131 "description": "The resource name of the Organizatio
n to fetch, e.g. \"organizations/1234\".", | |
132 "location": "path", | |
133 "pattern": "^organizations/[^/]+$", | |
134 "required": true, | |
135 "type": "string" | |
136 } | |
137 }, | |
138 "path": "v1/{+name}", | |
139 "response": { | |
140 "$ref": "Organization" | |
141 }, | |
142 "scopes": [ | |
143 "https://www.googleapis.com/auth/cloud-platform", | |
144 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
145 ] | |
146 }, | |
147 "testIamPermissions": { | 122 "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\".", | 123 "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", | 124 "httpMethod": "POST", |
150 "id": "cloudresourcemanager.organizations.testIamPermissions
", | 125 "id": "cloudresourcemanager.organizations.testIamPermissions
", |
151 "parameterOrder": [ | 126 "parameterOrder": [ |
152 "resource" | 127 "resource" |
153 ], | 128 ], |
154 "parameters": { | 129 "parameters": { |
155 "resource": { | 130 "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}`.", | 131 "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", | 132 "location": "path", |
158 "pattern": "^organizations/[^/]+$", | 133 "pattern": "^organizations/[^/]+$", |
159 "required": true, | 134 "required": true, |
160 "type": "string" | 135 "type": "string" |
161 } | 136 } |
162 }, | 137 }, |
163 "path": "v1/{+resource}:testIamPermissions", | 138 "path": "v1/{+resource}:testIamPermissions", |
164 "request": { | 139 "request": { |
165 "$ref": "TestIamPermissionsRequest" | 140 "$ref": "TestIamPermissionsRequest" |
166 }, | 141 }, |
167 "response": { | 142 "response": { |
168 "$ref": "TestIamPermissionsResponse" | 143 "$ref": "TestIamPermissionsResponse" |
169 }, | 144 }, |
170 "scopes": [ | 145 "scopes": [ |
171 "https://www.googleapis.com/auth/cloud-platform", | 146 "https://www.googleapis.com/auth/cloud-platform", |
| 147 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 148 ] |
| 149 }, |
| 150 "getIamPolicy": { |
| 151 "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\
".", |
| 152 "httpMethod": "POST", |
| 153 "id": "cloudresourcemanager.organizations.getIamPolicy", |
| 154 "parameterOrder": [ |
| 155 "resource" |
| 156 ], |
| 157 "parameters": { |
| 158 "resource": { |
| 159 "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}`.", |
| 160 "location": "path", |
| 161 "pattern": "^organizations/[^/]+$", |
| 162 "required": true, |
| 163 "type": "string" |
| 164 } |
| 165 }, |
| 166 "path": "v1/{+resource}:getIamPolicy", |
| 167 "request": { |
| 168 "$ref": "GetIamPolicyRequest" |
| 169 }, |
| 170 "response": { |
| 171 "$ref": "Policy" |
| 172 }, |
| 173 "scopes": [ |
| 174 "https://www.googleapis.com/auth/cloud-platform", |
172 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 175 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
173 ] | 176 ] |
174 }, | 177 }, |
175 "search": { | 178 "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.", | 179 "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", | 180 "httpMethod": "POST", |
178 "id": "cloudresourcemanager.organizations.search", | 181 "id": "cloudresourcemanager.organizations.search", |
179 "parameterOrder": [], | 182 "parameterOrder": [], |
180 "parameters": {}, | 183 "parameters": {}, |
181 "path": "v1/organizations:search", | 184 "path": "v1/organizations:search", |
182 "request": { | 185 "request": { |
183 "$ref": "SearchOrganizationsRequest" | 186 "$ref": "SearchOrganizationsRequest" |
184 }, | 187 }, |
185 "response": { | 188 "response": { |
186 "$ref": "SearchOrganizationsResponse" | 189 "$ref": "SearchOrganizationsResponse" |
187 }, | 190 }, |
188 "scopes": [ | 191 "scopes": [ |
189 "https://www.googleapis.com/auth/cloud-platform", | 192 "https://www.googleapis.com/auth/cloud-platform", |
190 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 193 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
191 ] | 194 ] |
192 }, | 195 }, |
| 196 "get": { |
| 197 "description": "Fetches an Organization resource identified
by the specified resource name.", |
| 198 "httpMethod": "GET", |
| 199 "id": "cloudresourcemanager.organizations.get", |
| 200 "parameterOrder": [ |
| 201 "name" |
| 202 ], |
| 203 "parameters": { |
| 204 "name": { |
| 205 "description": "The resource name of the Organizatio
n to fetch, e.g. \"organizations/1234\".", |
| 206 "location": "path", |
| 207 "pattern": "^organizations/[^/]+$", |
| 208 "required": true, |
| 209 "type": "string" |
| 210 } |
| 211 }, |
| 212 "path": "v1/{+name}", |
| 213 "response": { |
| 214 "$ref": "Organization" |
| 215 }, |
| 216 "scopes": [ |
| 217 "https://www.googleapis.com/auth/cloud-platform", |
| 218 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 219 ] |
| 220 }, |
193 "setIamPolicy": { | 221 "setIamPolicy": { |
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\".", | 222 "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\".", |
195 "httpMethod": "POST", | 223 "httpMethod": "POST", |
196 "id": "cloudresourcemanager.organizations.setIamPolicy", | 224 "id": "cloudresourcemanager.organizations.setIamPolicy", |
197 "parameterOrder": [ | 225 "parameterOrder": [ |
198 "resource" | 226 "resource" |
199 ], | 227 ], |
200 "parameters": { | 228 "parameters": { |
201 "resource": { | 229 "resource": { |
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}`.", | 230 "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}`.", |
203 "location": "path", | 231 "location": "path", |
204 "pattern": "^organizations/[^/]+$", | 232 "pattern": "^organizations/[^/]+$", |
205 "required": true, | 233 "required": true, |
206 "type": "string" | 234 "type": "string" |
207 } | 235 } |
208 }, | 236 }, |
209 "path": "v1/{+resource}:setIamPolicy", | 237 "path": "v1/{+resource}:setIamPolicy", |
210 "request": { | 238 "request": { |
211 "$ref": "SetIamPolicyRequest" | 239 "$ref": "SetIamPolicyRequest" |
212 }, | 240 }, |
213 "response": { | 241 "response": { |
214 "$ref": "Policy" | 242 "$ref": "Policy" |
215 }, | 243 }, |
216 "scopes": [ | 244 "scopes": [ |
217 "https://www.googleapis.com/auth/cloud-platform" | 245 "https://www.googleapis.com/auth/cloud-platform" |
218 ] | 246 ] |
219 }, | 247 } |
220 "getIamPolicy": { | 248 } |
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\
".", | 249 }, |
222 "httpMethod": "POST", | 250 "operations": { |
223 "id": "cloudresourcemanager.organizations.getIamPolicy", | 251 "methods": { |
| 252 "get": { |
| 253 "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.", |
| 254 "httpMethod": "GET", |
| 255 "id": "cloudresourcemanager.operations.get", |
224 "parameterOrder": [ | 256 "parameterOrder": [ |
225 "resource" | 257 "name" |
226 ], | 258 ], |
227 "parameters": { | 259 "parameters": { |
228 "resource": { | 260 "name": { |
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}`.", | 261 "description": "The name of the operation resource."
, |
230 "location": "path", | 262 "location": "path", |
231 "pattern": "^organizations/[^/]+$", | 263 "pattern": "^operations/.+$", |
232 "required": true, | 264 "required": true, |
233 "type": "string" | 265 "type": "string" |
234 } | 266 } |
235 }, | 267 }, |
236 "path": "v1/{+resource}:getIamPolicy", | 268 "path": "v1/{+name}", |
237 "request": { | |
238 "$ref": "GetIamPolicyRequest" | |
239 }, | |
240 "response": { | 269 "response": { |
241 "$ref": "Policy" | 270 "$ref": "Operation" |
242 }, | 271 }, |
243 "scopes": [ | 272 "scopes": [ |
244 "https://www.googleapis.com/auth/cloud-platform", | 273 "https://www.googleapis.com/auth/cloud-platform", |
245 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 274 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
246 ] | 275 ] |
247 } | 276 } |
248 } | 277 } |
249 }, | 278 }, |
250 "projects": { | 279 "projects": { |
251 "methods": { | 280 "methods": { |
252 "getAncestry": { | 281 "get": { |
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.", | 282 "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.", |
254 "httpMethod": "POST", | 283 "httpMethod": "GET", |
255 "id": "cloudresourcemanager.projects.getAncestry", | 284 "id": "cloudresourcemanager.projects.get", |
256 "parameterOrder": [ | 285 "parameterOrder": [ |
257 "projectId" | 286 "projectId" |
258 ], | 287 ], |
259 "parameters": { | 288 "parameters": { |
260 "projectId": { | 289 "projectId": { |
261 "description": "The Project ID (for example, `my-pro
ject-123`).\n\nRequired.", | 290 "description": "The Project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
262 "location": "path", | 291 "location": "path", |
263 "required": true, | 292 "required": true, |
264 "type": "string" | 293 "type": "string" |
265 } | 294 } |
266 }, | 295 }, |
267 "path": "v1/projects/{projectId}:getAncestry", | 296 "path": "v1/projects/{projectId}", |
268 "request": { | |
269 "$ref": "GetAncestryRequest" | |
270 }, | |
271 "response": { | 297 "response": { |
272 "$ref": "GetAncestryResponse" | 298 "$ref": "Project" |
273 }, | 299 }, |
274 "scopes": [ | 300 "scopes": [ |
275 "https://www.googleapis.com/auth/cloud-platform", | 301 "https://www.googleapis.com/auth/cloud-platform", |
276 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
277 ] | |
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" | 302 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
304 ] | 303 ] |
305 }, | 304 }, |
306 "undelete": { | 305 "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.", | 306 "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", | 307 "httpMethod": "POST", |
309 "id": "cloudresourcemanager.projects.undelete", | 308 "id": "cloudresourcemanager.projects.undelete", |
310 "parameterOrder": [ | 309 "parameterOrder": [ |
311 "projectId" | 310 "projectId" |
312 ], | 311 ], |
313 "parameters": { | 312 "parameters": { |
314 "projectId": { | 313 "projectId": { |
315 "description": "The project ID (for example, `foo-ba
r-123`).\n\nRequired.", | 314 "description": "The project ID (for example, `foo-ba
r-123`).\n\nRequired.", |
316 "location": "path", | 315 "location": "path", |
317 "required": true, | 316 "required": true, |
318 "type": "string" | 317 "type": "string" |
319 } | 318 } |
320 }, | 319 }, |
321 "path": "v1/projects/{projectId}:undelete", | 320 "path": "v1/projects/{projectId}:undelete", |
322 "request": { | 321 "request": { |
323 "$ref": "UndeleteProjectRequest" | 322 "$ref": "UndeleteProjectRequest" |
324 }, | 323 }, |
325 "response": { | 324 "response": { |
326 "$ref": "Empty" | 325 "$ref": "Empty" |
327 }, | 326 }, |
328 "scopes": [ | 327 "scopes": [ |
329 "https://www.googleapis.com/auth/cloud-platform" | 328 "https://www.googleapis.com/auth/cloud-platform" |
330 ] | 329 ] |
331 }, | 330 }, |
332 "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.", | |
334 "httpMethod": "GET", | |
335 "id": "cloudresourcemanager.projects.list", | |
336 "parameterOrder": [], | |
337 "parameters": { | |
338 "pageSize": { | |
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.", | |
340 "format": "int32", | |
341 "location": "query", | |
342 "type": "integer" | |
343 }, | |
344 "filter": { | |
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.", | |
351 "location": "query", | |
352 "type": "string" | |
353 } | |
354 }, | |
355 "path": "v1/projects", | |
356 "response": { | |
357 "$ref": "ListProjectsResponse" | |
358 }, | |
359 "scopes": [ | |
360 "https://www.googleapis.com/auth/cloud-platform", | |
361 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
362 ] | |
363 }, | |
364 "get": { | |
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.", | |
366 "httpMethod": "GET", | |
367 "id": "cloudresourcemanager.projects.get", | |
368 "parameterOrder": [ | |
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": { | |
381 "$ref": "Project" | |
382 }, | |
383 "scopes": [ | |
384 "https://www.googleapis.com/auth/cloud-platform", | |
385 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
386 ] | |
387 }, | |
388 "update": { | 331 "update": { |
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.", | 332 "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.", |
390 "httpMethod": "PUT", | 333 "httpMethod": "PUT", |
391 "id": "cloudresourcemanager.projects.update", | 334 "id": "cloudresourcemanager.projects.update", |
392 "parameterOrder": [ | 335 "parameterOrder": [ |
393 "projectId" | 336 "projectId" |
394 ], | 337 ], |
395 "parameters": { | 338 "parameters": { |
396 "projectId": { | 339 "projectId": { |
397 "description": "The project ID (for example, `my-pro
ject-123`).\n\nRequired.", | 340 "description": "The project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
398 "location": "path", | 341 "location": "path", |
399 "required": true, | 342 "required": true, |
400 "type": "string" | 343 "type": "string" |
401 } | 344 } |
402 }, | 345 }, |
403 "path": "v1/projects/{projectId}", | 346 "path": "v1/projects/{projectId}", |
404 "request": { | 347 "request": { |
405 "$ref": "Project" | 348 "$ref": "Project" |
406 }, | 349 }, |
407 "response": { | 350 "response": { |
408 "$ref": "Project" | 351 "$ref": "Project" |
409 }, | 352 }, |
410 "scopes": [ | 353 "scopes": [ |
411 "https://www.googleapis.com/auth/cloud-platform" | 354 "https://www.googleapis.com/auth/cloud-platform" |
412 ] | 355 ] |
413 }, | 356 }, |
414 "create": { | 357 "getAncestry": { |
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.", | 358 "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.", |
416 "httpMethod": "POST", | 359 "httpMethod": "POST", |
417 "id": "cloudresourcemanager.projects.create", | 360 "id": "cloudresourcemanager.projects.getAncestry", |
418 "parameterOrder": [], | 361 "parameterOrder": [ |
419 "parameters": {}, | 362 "projectId" |
420 "path": "v1/projects", | 363 ], |
| 364 "parameters": { |
| 365 "projectId": { |
| 366 "description": "The Project ID (for example, `my-pro
ject-123`).\n\nRequired.", |
| 367 "location": "path", |
| 368 "required": true, |
| 369 "type": "string" |
| 370 } |
| 371 }, |
| 372 "path": "v1/projects/{projectId}:getAncestry", |
421 "request": { | 373 "request": { |
422 "$ref": "Project" | 374 "$ref": "GetAncestryRequest" |
423 }, | 375 }, |
424 "response": { | 376 "response": { |
425 "$ref": "Operation" | 377 "$ref": "GetAncestryResponse" |
426 }, | 378 }, |
427 "scopes": [ | 379 "scopes": [ |
428 "https://www.googleapis.com/auth/cloud-platform" | 380 "https://www.googleapis.com/auth/cloud-platform", |
| 381 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
429 ] | 382 ] |
430 }, | 383 }, |
431 "setIamPolicy": { | 384 "testIamPermissions": { |
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.", | 385 "description": "Returns permissions that a caller has on the
specified Project.", |
433 "httpMethod": "POST", | 386 "httpMethod": "POST", |
434 "id": "cloudresourcemanager.projects.setIamPolicy", | 387 "id": "cloudresourcemanager.projects.testIamPermissions", |
435 "parameterOrder": [ | 388 "parameterOrder": [ |
436 "resource" | 389 "resource" |
437 ], | 390 ], |
438 "parameters": { | 391 "parameters": { |
439 "resource": { | 392 "resource": { |
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}`.", | 393 "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}`.", |
441 "location": "path", | 394 "location": "path", |
442 "required": true, | 395 "required": true, |
443 "type": "string" | 396 "type": "string" |
444 } | 397 } |
445 }, | 398 }, |
446 "path": "v1/projects/{resource}:setIamPolicy", | 399 "path": "v1/projects/{resource}:testIamPermissions", |
447 "request": { | 400 "request": { |
448 "$ref": "SetIamPolicyRequest" | 401 "$ref": "TestIamPermissionsRequest" |
449 }, | 402 }, |
450 "response": { | 403 "response": { |
451 "$ref": "Policy" | 404 "$ref": "TestIamPermissionsResponse" |
452 }, | 405 }, |
453 "scopes": [ | 406 "scopes": [ |
454 "https://www.googleapis.com/auth/cloud-platform" | 407 "https://www.googleapis.com/auth/cloud-platform", |
| 408 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
455 ] | 409 ] |
456 }, | 410 }, |
457 "delete": { | 411 "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.", | 412 "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", | 413 "httpMethod": "DELETE", |
460 "id": "cloudresourcemanager.projects.delete", | 414 "id": "cloudresourcemanager.projects.delete", |
461 "parameterOrder": [ | 415 "parameterOrder": [ |
462 "projectId" | 416 "projectId" |
463 ], | 417 ], |
464 "parameters": { | 418 "parameters": { |
465 "projectId": { | 419 "projectId": { |
466 "description": "The Project ID (for example, `foo-ba
r-123`).\n\nRequired.", | 420 "description": "The Project ID (for example, `foo-ba
r-123`).\n\nRequired.", |
467 "location": "path", | 421 "location": "path", |
468 "required": true, | 422 "required": true, |
469 "type": "string" | 423 "type": "string" |
470 } | 424 } |
471 }, | 425 }, |
472 "path": "v1/projects/{projectId}", | 426 "path": "v1/projects/{projectId}", |
473 "response": { | 427 "response": { |
474 "$ref": "Empty" | 428 "$ref": "Empty" |
475 }, | 429 }, |
476 "scopes": [ | 430 "scopes": [ |
477 "https://www.googleapis.com/auth/cloud-platform" | 431 "https://www.googleapis.com/auth/cloud-platform" |
478 ] | 432 ] |
479 }, | 433 }, |
480 "testIamPermissions": { | 434 "list": { |
481 "description": "Returns permissions that a caller has on the
specified Project.", | 435 "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.", |
| 436 "httpMethod": "GET", |
| 437 "id": "cloudresourcemanager.projects.list", |
| 438 "parameterOrder": [], |
| 439 "parameters": { |
| 440 "filter": { |
| 441 "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.", |
| 442 "location": "query", |
| 443 "type": "string" |
| 444 }, |
| 445 "pageToken": { |
| 446 "description": "A pagination token returned from a p
revious call to ListProjects\nthat indicates from where listing should continue.
\n\nOptional.", |
| 447 "location": "query", |
| 448 "type": "string" |
| 449 }, |
| 450 "pageSize": { |
| 451 "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.", |
| 452 "format": "int32", |
| 453 "location": "query", |
| 454 "type": "integer" |
| 455 } |
| 456 }, |
| 457 "path": "v1/projects", |
| 458 "response": { |
| 459 "$ref": "ListProjectsResponse" |
| 460 }, |
| 461 "scopes": [ |
| 462 "https://www.googleapis.com/auth/cloud-platform", |
| 463 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
| 464 ] |
| 465 }, |
| 466 "setIamPolicy": { |
| 467 "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.", |
482 "httpMethod": "POST", | 468 "httpMethod": "POST", |
483 "id": "cloudresourcemanager.projects.testIamPermissions", | 469 "id": "cloudresourcemanager.projects.setIamPolicy", |
484 "parameterOrder": [ | 470 "parameterOrder": [ |
485 "resource" | 471 "resource" |
486 ], | 472 ], |
487 "parameters": { | 473 "parameters": { |
488 "resource": { | 474 "resource": { |
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}`.", | 475 "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}`.", |
490 "location": "path", | 476 "location": "path", |
491 "required": true, | 477 "required": true, |
492 "type": "string" | 478 "type": "string" |
493 } | 479 } |
494 }, | 480 }, |
495 "path": "v1/projects/{resource}:testIamPermissions", | 481 "path": "v1/projects/{resource}:setIamPolicy", |
496 "request": { | 482 "request": { |
497 "$ref": "TestIamPermissionsRequest" | 483 "$ref": "SetIamPolicyRequest" |
498 }, | 484 }, |
499 "response": { | 485 "response": { |
500 "$ref": "TestIamPermissionsResponse" | 486 "$ref": "Policy" |
501 }, | 487 }, |
502 "scopes": [ | 488 "scopes": [ |
503 "https://www.googleapis.com/auth/cloud-platform", | 489 "https://www.googleapis.com/auth/cloud-platform" |
504 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | |
505 ] | 490 ] |
506 } | 491 }, |
507 } | 492 "create": { |
508 }, | 493 "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.", |
509 "operations": { | 494 "httpMethod": "POST", |
510 "methods": { | 495 "id": "cloudresourcemanager.projects.create", |
511 "get": { | 496 "parameterOrder": [], |
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.", | 497 "parameters": {}, |
513 "httpMethod": "GET", | 498 "path": "v1/projects", |
514 "id": "cloudresourcemanager.operations.get", | 499 "request": { |
| 500 "$ref": "Project" |
| 501 }, |
| 502 "response": { |
| 503 "$ref": "Operation" |
| 504 }, |
| 505 "scopes": [ |
| 506 "https://www.googleapis.com/auth/cloud-platform" |
| 507 ] |
| 508 }, |
| 509 "getIamPolicy": { |
| 510 "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.", |
| 511 "httpMethod": "POST", |
| 512 "id": "cloudresourcemanager.projects.getIamPolicy", |
515 "parameterOrder": [ | 513 "parameterOrder": [ |
516 "name" | 514 "resource" |
517 ], | 515 ], |
518 "parameters": { | 516 "parameters": { |
519 "name": { | 517 "resource": { |
520 "description": "The name of the operation resource."
, | 518 "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}`.", |
521 "location": "path", | 519 "location": "path", |
522 "pattern": "^operations/.+$", | |
523 "required": true, | 520 "required": true, |
524 "type": "string" | 521 "type": "string" |
525 } | 522 } |
526 }, | 523 }, |
527 "path": "v1/{+name}", | 524 "path": "v1/projects/{resource}:getIamPolicy", |
| 525 "request": { |
| 526 "$ref": "GetIamPolicyRequest" |
| 527 }, |
528 "response": { | 528 "response": { |
529 "$ref": "Operation" | 529 "$ref": "Policy" |
530 }, | 530 }, |
531 "scopes": [ | 531 "scopes": [ |
532 "https://www.googleapis.com/auth/cloud-platform", | 532 "https://www.googleapis.com/auth/cloud-platform", |
533 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" | 533 "https://www.googleapis.com/auth/cloud-platform.read-onl
y" |
534 ] | 534 ] |
535 } | 535 } |
536 } | 536 } |
537 } | 537 } |
538 }, | 538 }, |
539 "revision": "20170118", | 539 "revision": "20170206", |
540 "rootUrl": "https://cloudresourcemanager.googleapis.com/", | 540 "rootUrl": "https://cloudresourcemanager.googleapis.com/", |
541 "schemas": { | 541 "schemas": { |
542 "FolderOperationError": { | 542 "SetIamPolicyRequest": { |
543 "description": "A classification of the Folder Operation error.", | 543 "description": "Request message for `SetIamPolicy` method.", |
544 "id": "FolderOperationError", | 544 "id": "SetIamPolicyRequest", |
545 "properties": { | 545 "properties": { |
546 "errorMessageId": { | 546 "policy": { |
547 "description": "The type of operation error experienced.", | 547 "$ref": "Policy", |
548 "enum": [ | 548 "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." |
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 ], | |
570 "type": "string" | |
571 } | 549 } |
572 }, | 550 }, |
573 "type": "object" | 551 "type": "object" |
574 }, | 552 }, |
575 "Status": { | 553 "Status": { |
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.", | 554 "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.", |
577 "id": "Status", | 555 "id": "Status", |
578 "properties": { | 556 "properties": { |
579 "code": { | 557 "code": { |
580 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 558 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
581 "format": "int32", | 559 "format": "int32", |
582 "type": "integer" | 560 "type": "integer" |
583 }, | 561 }, |
| 562 "message": { |
| 563 "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.", |
| 564 "type": "string" |
| 565 }, |
584 "details": { | 566 "details": { |
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.", | 567 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
586 "items": { | 568 "items": { |
587 "additionalProperties": { | 569 "additionalProperties": { |
588 "description": "Properties of the object. Contains f
ield @type with type URL.", | 570 "description": "Properties of the object. Contains f
ield @type with type URL.", |
589 "type": "any" | 571 "type": "any" |
590 }, | 572 }, |
591 "type": "object" | 573 "type": "object" |
592 }, | 574 }, |
593 "type": "array" | 575 "type": "array" |
| 576 } |
| 577 }, |
| 578 "type": "object" |
| 579 }, |
| 580 "Binding": { |
| 581 "description": "Associates `members` with a `role`.", |
| 582 "id": "Binding", |
| 583 "properties": { |
| 584 "members": { |
| 585 "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", |
| 586 "items": { |
| 587 "type": "string" |
| 588 }, |
| 589 "type": "array" |
594 }, | 590 }, |
595 "message": { | 591 "role": { |
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.", | 592 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
597 "type": "string" | 593 "type": "string" |
598 } | 594 } |
599 }, | 595 }, |
600 "type": "object" | 596 "type": "object" |
601 }, | 597 }, |
602 "ListProjectsResponse": { | 598 "Empty": { |
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.", | 599 "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 `{}`.", |
604 "id": "ListProjectsResponse", | 600 "id": "Empty", |
605 "properties": { | 601 "properties": {}, |
606 "projects": { | |
607 "description": "The list of Projects that matched the list f
ilter. This list can\nbe paginated.", | |
608 "items": { | |
609 "$ref": "Project" | |
610 }, | |
611 "type": "array" | |
612 }, | |
613 "nextPageToken": { | |
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."
, | |
615 "type": "string" | |
616 } | |
617 }, | |
618 "type": "object" | 602 "type": "object" |
619 }, | 603 }, |
620 "UndeleteProjectRequest": { | 604 "UndeleteProjectRequest": { |
621 "description": "The request sent to the UndeleteProject\nmethod.", | 605 "description": "The request sent to the UndeleteProject\nmethod.", |
622 "id": "UndeleteProjectRequest", | 606 "id": "UndeleteProjectRequest", |
623 "properties": {}, | 607 "properties": {}, |
624 "type": "object" | 608 "type": "object" |
625 }, | 609 }, |
626 "FolderOperation": { | 610 "Organization": { |
627 "description": "Metadata describing a long running folder operation"
, | 611 "description": "The root node in the resource hierarchy to which a p
articular entity's\n(e.g., company) resources belong.", |
628 "id": "FolderOperation", | 612 "id": "Organization", |
629 "properties": { | 613 "properties": { |
630 "displayName": { | 614 "owner": { |
631 "description": "The display name of the folder.", | 615 "$ref": "OrganizationOwner", |
| 616 "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 "lifecycleState": { |
| 619 "description": "The organization's current lifecycle state.
Assigned by the server.\n@OutputOnly", |
| 620 "enum": [ |
| 621 "LIFECYCLE_STATE_UNSPECIFIED", |
| 622 "ACTIVE", |
| 623 "DELETE_REQUESTED" |
| 624 ], |
| 625 "enumDescriptions": [ |
| 626 "Unspecified state. This is only useful for distinguish
ing unset values.", |
| 627 "The normal and active state.", |
| 628 "The organization has been marked for deletion by the us
er." |
| 629 ], |
632 "type": "string" | 630 "type": "string" |
633 }, | 631 }, |
634 "sourceParent": { | 632 "name": { |
635 "description": "The resource name of the folder's parent.\nO
nly applicable when the operation_type is MOVE.", | 633 "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\".", |
636 "type": "string" | 634 "type": "string" |
637 }, | 635 }, |
638 "destinationParent": { | 636 "displayName": { |
639 "description": "The resource name of the folder or organizat
ion we are either creating\nthe folder under or moving the folder to.", | 637 "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", |
640 "type": "string" | 638 "type": "string" |
641 }, | 639 }, |
642 "operationType": { | 640 "creationTime": { |
643 "description": "The type of this operation.", | 641 "description": "Timestamp when the Organization was created.
Assigned by the server.\n@OutputOnly", |
644 "enum": [ | 642 "format": "google-datetime", |
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" | 643 "type": "string" |
655 } | 644 } |
656 }, | 645 }, |
657 "type": "object" | 646 "type": "object" |
658 }, | 647 }, |
659 "Operation": { | 648 "ProjectCreationStatus": { |
660 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | 649 "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.", |
661 "id": "Operation", | 650 "id": "ProjectCreationStatus", |
662 "properties": { | 651 "properties": { |
663 "error": { | 652 "ready": { |
664 "$ref": "Status", | 653 "description": "True if the project creation process is comp
lete.", |
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" | 654 "type": "boolean" |
670 }, | 655 }, |
671 "metadata": { | 656 "createTime": { |
672 "additionalProperties": { | 657 "description": "Creation time of the project creation workfl
ow.", |
673 "description": "Properties of the object. Contains field
@type with type URL.", | 658 "format": "google-datetime", |
674 "type": "any" | 659 "type": "string" |
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 }, | 660 }, |
679 "response": { | 661 "gettable": { |
680 "additionalProperties": { | 662 "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.", |
681 "description": "Properties of the object. Contains field
@type with type URL.", | 663 "type": "boolean" |
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 } | 664 } |
691 }, | 665 }, |
692 "type": "object" | 666 "type": "object" |
| 667 }, |
| 668 "TestIamPermissionsResponse": { |
| 669 "description": "Response message for `TestIamPermissions` method.", |
| 670 "id": "TestIamPermissionsResponse", |
| 671 "properties": { |
| 672 "permissions": { |
| 673 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 674 "items": { |
| 675 "type": "string" |
| 676 }, |
| 677 "type": "array" |
| 678 } |
| 679 }, |
| 680 "type": "object" |
693 }, | 681 }, |
694 "GetIamPolicyRequest": { | 682 "GetIamPolicyRequest": { |
695 "description": "Request message for `GetIamPolicy` method.", | 683 "description": "Request message for `GetIamPolicy` method.", |
696 "id": "GetIamPolicyRequest", | 684 "id": "GetIamPolicyRequest", |
697 "properties": {}, | 685 "properties": {}, |
698 "type": "object" | 686 "type": "object" |
699 }, | 687 }, |
700 "SetIamPolicyRequest": { | 688 "GetAncestryResponse": { |
701 "description": "Request message for `SetIamPolicy` method.", | 689 "description": "Response from the GetAncestry method.", |
702 "id": "SetIamPolicyRequest", | 690 "id": "GetAncestryResponse", |
703 "properties": { | 691 "properties": { |
704 "policy": { | 692 "ancestor": { |
705 "$ref": "Policy", | 693 "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.", |
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": { | 694 "items": { |
718 "type": "string" | 695 "$ref": "Ancestor" |
719 }, | 696 }, |
720 "type": "array" | 697 "type": "array" |
721 } | 698 } |
722 }, | 699 }, |
723 "type": "object" | 700 "type": "object" |
724 }, | 701 }, |
725 "Organization": { | 702 "OrganizationOwner": { |
726 "description": "The root node in the resource hierarchy to which a p
articular entity's\n(e.g., company) resources belong.", | 703 "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.", |
727 "id": "Organization", | 704 "id": "OrganizationOwner", |
728 "properties": { | 705 "properties": { |
729 "displayName": { | 706 "directoryCustomerId": { |
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", | 707 "description": "The Google for Work customer id used in the
Directory API.", |
731 "type": "string" | |
732 }, | |
733 "creationTime": { | |
734 "description": "Timestamp when the Organization was created.
Assigned by the server.\n@OutputOnly", | |
735 "format": "google-datetime", | |
736 "type": "string" | |
737 }, | |
738 "owner": { | |
739 "$ref": "OrganizationOwner", | |
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." | |
741 }, | |
742 "lifecycleState": { | |
743 "description": "The organization's current lifecycle state.
Assigned by the server.\n@OutputOnly", | |
744 "enum": [ | |
745 "LIFECYCLE_STATE_UNSPECIFIED", | |
746 "ACTIVE", | |
747 "DELETE_REQUESTED" | |
748 ], | |
749 "enumDescriptions": [ | |
750 "Unspecified state. This is only useful for distinguish
ing unset values.", | |
751 "The normal and active state.", | |
752 "The organization has been marked for deletion by the us
er." | |
753 ], | |
754 "type": "string" | |
755 }, | |
756 "name": { | |
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\".", | |
758 "type": "string" | 708 "type": "string" |
759 } | 709 } |
760 }, | 710 }, |
761 "type": "object" | 711 "type": "object" |
762 }, | 712 }, |
763 "Policy": { | 713 "ListProjectsResponse": { |
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).", | 714 "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.", |
765 "id": "Policy", | 715 "id": "ListProjectsResponse", |
766 "properties": { | 716 "properties": { |
767 "bindings": { | 717 "projects": { |
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.", | 718 "description": "The list of Projects that matched the list f
ilter. This list can\nbe paginated.", |
769 "items": { | 719 "items": { |
770 "$ref": "Binding" | 720 "$ref": "Project" |
771 }, | 721 }, |
772 "type": "array" | 722 "type": "array" |
773 }, | 723 }, |
774 "etag": { | 724 "nextPageToken": { |
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.", | 725 "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."
, |
776 "format": "byte", | |
777 "type": "string" | 726 "type": "string" |
778 }, | |
779 "version": { | |
780 "description": "Version of the `Policy`. The default version
is 0.", | |
781 "format": "int32", | |
782 "type": "integer" | |
783 } | 727 } |
784 }, | 728 }, |
785 "type": "object" | 729 "type": "object" |
786 }, | 730 }, |
787 "ProjectCreationStatus": { | 731 "SearchOrganizationsRequest": { |
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.", | 732 "description": "The request sent to the `SearchOrganizations` method
.", |
789 "id": "ProjectCreationStatus", | 733 "id": "SearchOrganizationsRequest", |
790 "properties": { | 734 "properties": { |
791 "ready": { | 735 "pageSize": { |
792 "description": "True if the project creation process is comp
lete.", | 736 "description": "The maximum number of Organizations to retur
n in the response.\nThis field is optional.", |
793 "type": "boolean" | 737 "format": "int32", |
| 738 "type": "integer" |
794 }, | 739 }, |
795 "gettable": { | 740 "filter": { |
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.", | 741 "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."
, |
797 "type": "boolean" | 742 "type": "string" |
798 }, | 743 }, |
799 "createTime": { | 744 "pageToken": { |
800 "description": "Creation time of the project creation workfl
ow.", | 745 "description": "A pagination token returned from a previous
call to `SearchOrganizations`\nthat indicates from where listing should continue
.\nThis field is optional.", |
801 "format": "google-datetime", | |
802 "type": "string" | 746 "type": "string" |
803 } | 747 } |
804 }, | 748 }, |
805 "type": "object" | 749 "type": "object" |
| 750 }, |
| 751 "GetAncestryRequest": { |
| 752 "description": "The request sent to the\nGetAncestry\nmethod.", |
| 753 "id": "GetAncestryRequest", |
| 754 "properties": {}, |
| 755 "type": "object" |
| 756 }, |
| 757 "Project": { |
| 758 "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.", |
| 759 "id": "Project", |
| 760 "properties": { |
| 761 "projectNumber": { |
| 762 "description": "The number uniquely identifying the project.
\n\nExample: <code>415104041262</code>\nRead-only.", |
| 763 "format": "int64", |
| 764 "type": "string" |
| 765 }, |
| 766 "parent": { |
| 767 "$ref": "ResourceId", |
| 768 "description": "An optional reference to a parent Resource.\
n\nThe only supported parent type is \"organization\". Once set, the parent\ncan
not be modified. The `parent` can be set on creation or using the\n`UpdateProjec
t` method; the end user must have the\n`resourcemanager.projects.create` permiss
ion on the parent.\n\nRead-write." |
| 769 }, |
| 770 "labels": { |
| 771 "additionalProperties": { |
| 772 "type": "string" |
| 773 }, |
| 774 "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>\nRead-write.", |
| 775 "type": "object" |
| 776 }, |
| 777 "createTime": { |
| 778 "description": "Creation time.\n\nRead-only.", |
| 779 "format": "google-datetime", |
| 780 "type": "string" |
| 781 }, |
| 782 "name": { |
| 783 "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>\nRead-write.", |
| 784 "type": "string" |
| 785 }, |
| 786 "projectId": { |
| 787 "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>\nRead-only after creation.", |
| 788 "type": "string" |
| 789 }, |
| 790 "lifecycleState": { |
| 791 "description": "The Project lifecycle state.\n\nRead-only.", |
| 792 "enum": [ |
| 793 "LIFECYCLE_STATE_UNSPECIFIED", |
| 794 "ACTIVE", |
| 795 "DELETE_REQUESTED", |
| 796 "DELETE_IN_PROGRESS" |
| 797 ], |
| 798 "enumDescriptions": [ |
| 799 "Unspecified state. This is only used/useful for distin
guishing\nunset values.", |
| 800 "The normal and active state.", |
| 801 "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.", |
| 802 "This lifecycle state is no longer used and not returned
by the API." |
| 803 ], |
| 804 "type": "string" |
| 805 } |
| 806 }, |
| 807 "type": "object" |
| 808 }, |
| 809 "SearchOrganizationsResponse": { |
| 810 "description": "The response returned from the `SearchOrganizations`
method.", |
| 811 "id": "SearchOrganizationsResponse", |
| 812 "properties": { |
| 813 "nextPageToken": { |
| 814 "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.", |
| 815 "type": "string" |
| 816 }, |
| 817 "organizations": { |
| 818 "description": "The list of Organizations that matched the s
earch query, possibly\npaginated.", |
| 819 "items": { |
| 820 "$ref": "Organization" |
| 821 }, |
| 822 "type": "array" |
| 823 } |
| 824 }, |
| 825 "type": "object" |
806 }, | 826 }, |
807 "TestIamPermissionsRequest": { | 827 "TestIamPermissionsRequest": { |
808 "description": "Request message for `TestIamPermissions` method.", | 828 "description": "Request message for `TestIamPermissions` method.", |
809 "id": "TestIamPermissionsRequest", | 829 "id": "TestIamPermissionsRequest", |
810 "properties": { | 830 "properties": { |
811 "permissions": { | 831 "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).", | 832 "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).", |
813 "items": { | 833 "items": { |
814 "type": "string" | 834 "type": "string" |
815 }, | 835 }, |
816 "type": "array" | 836 "type": "array" |
817 } | 837 } |
818 }, | 838 }, |
819 "type": "object" | 839 "type": "object" |
820 }, | 840 }, |
821 "GetAncestryRequest": { | 841 "FolderOperationError": { |
822 "description": "The request sent to the\nGetAncestry\nmethod.", | 842 "description": "A classification of the Folder Operation error.", |
823 "id": "GetAncestryRequest", | 843 "id": "FolderOperationError", |
824 "properties": {}, | 844 "properties": { |
| 845 "errorMessageId": { |
| 846 "description": "The type of operation error experienced.", |
| 847 "enum": [ |
| 848 "ERROR_TYPE_UNSPECIFIED", |
| 849 "FOLDER_HEIGHT_VIOLATION", |
| 850 "MAX_CHILD_FOLDERS_VIOLATION", |
| 851 "FOLDER_NAME_UNIQUENESS_VIOLATION", |
| 852 "RESOURCE_DELETED", |
| 853 "PARENT_DELETED", |
| 854 "CYCLE_INTRODUCED_ERROR", |
| 855 "FOLDER_ALREADY_BEING_MOVED", |
| 856 "FOLDER_TO_DELETE_NON_EMPTY" |
| 857 ], |
| 858 "enumDescriptions": [ |
| 859 "The error type was unrecognized or unspecified.", |
| 860 "The attempted action would violate the max folder depth
constraint.", |
| 861 "The attempted action would violate the max child folder
s constraint.", |
| 862 "The attempted action would violate the locally-unique f
older\ndisplay_name constraint.", |
| 863 "The resource being moved has been deleted.", |
| 864 "The resource a folder was being added to has been delet
ed.", |
| 865 "The attempted action would introduce cycle in resource
path.", |
| 866 "The attempted action would move a folder that is alread
y being moved.", |
| 867 "The folder the caller is trying to delete contains acti
ve resources." |
| 868 ], |
| 869 "type": "string" |
| 870 } |
| 871 }, |
825 "type": "object" | 872 "type": "object" |
826 }, | 873 }, |
827 "GetAncestryResponse": { | 874 "FolderOperation": { |
828 "description": "Response from the GetAncestry method.", | 875 "description": "Metadata describing a long running folder operation"
, |
829 "id": "GetAncestryResponse", | 876 "id": "FolderOperation", |
830 "properties": { | 877 "properties": { |
831 "ancestor": { | 878 "displayName": { |
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.", | 879 "description": "The display name of the folder.", |
| 880 "type": "string" |
| 881 }, |
| 882 "sourceParent": { |
| 883 "description": "The resource name of the folder's parent.\nO
nly applicable when the operation_type is MOVE.", |
| 884 "type": "string" |
| 885 }, |
| 886 "destinationParent": { |
| 887 "description": "The resource name of the folder or organizat
ion we are either creating\nthe folder under or moving the folder to.", |
| 888 "type": "string" |
| 889 }, |
| 890 "operationType": { |
| 891 "description": "The type of this operation.", |
| 892 "enum": [ |
| 893 "OPERATION_TYPE_UNSPECIFIED", |
| 894 "CREATE", |
| 895 "MOVE" |
| 896 ], |
| 897 "enumDescriptions": [ |
| 898 "Operation type not specified.", |
| 899 "A create folder operation.", |
| 900 "A move folder operation." |
| 901 ], |
| 902 "type": "string" |
| 903 } |
| 904 }, |
| 905 "type": "object" |
| 906 }, |
| 907 "Policy": { |
| 908 "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).", |
| 909 "id": "Policy", |
| 910 "properties": { |
| 911 "etag": { |
| 912 "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.", |
| 913 "format": "byte", |
| 914 "type": "string" |
| 915 }, |
| 916 "version": { |
| 917 "description": "Version of the `Policy`. The default version
is 0.", |
| 918 "format": "int32", |
| 919 "type": "integer" |
| 920 }, |
| 921 "bindings": { |
| 922 "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.", |
833 "items": { | 923 "items": { |
834 "$ref": "Ancestor" | 924 "$ref": "Binding" |
835 }, | 925 }, |
836 "type": "array" | 926 "type": "array" |
837 } | 927 } |
838 }, | 928 }, |
839 "type": "object" | 929 "type": "object" |
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 }, | 930 }, |
896 "ResourceId": { | 931 "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.
", | 932 "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", | 933 "id": "ResourceId", |
899 "properties": { | 934 "properties": { |
900 "type": { | 935 "type": { |
901 "description": "Required field representing the resource typ
e this id is for.\nAt present, the only valid type is \"organization\".", | 936 "description": "Required field representing the resource typ
e this id is for.\nAt present, the only valid type is \"organization\".", |
902 "type": "string" | 937 "type": "string" |
903 }, | 938 }, |
904 "id": { | 939 "id": { |
905 "description": "Required field for the type-specific id. Thi
s should correspond to the id\nused in the type-specific API's.", | 940 "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" | 941 "type": "string" |
907 } | 942 } |
908 }, | 943 }, |
909 "type": "object" | 944 "type": "object" |
910 }, | 945 }, |
911 "Binding": { | 946 "Operation": { |
912 "description": "Associates `members` with a `role`.", | 947 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
913 "id": "Binding", | 948 "id": "Operation", |
914 "properties": { | 949 "properties": { |
915 "members": { | 950 "error": { |
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", | 951 "$ref": "Status", |
917 "items": { | 952 "description": "The error result of the operation in case of
failure or cancellation." |
918 "type": "string" | 953 }, |
| 954 "metadata": { |
| 955 "additionalProperties": { |
| 956 "description": "Properties of the object. Contains field
@type with type URL.", |
| 957 "type": "any" |
919 }, | 958 }, |
920 "type": "array" | 959 "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.
", |
| 960 "type": "object" |
921 }, | 961 }, |
922 "role": { | 962 "done": { |
923 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 963 "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.", |
| 964 "type": "boolean" |
| 965 }, |
| 966 "response": { |
| 967 "additionalProperties": { |
| 968 "description": "Properties of the object. Contains field
@type with type URL.", |
| 969 "type": "any" |
| 970 }, |
| 971 "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`.", |
| 972 "type": "object" |
| 973 }, |
| 974 "name": { |
| 975 "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`
.", |
924 "type": "string" | 976 "type": "string" |
925 } | 977 } |
926 }, | 978 }, |
927 "type": "object" | 979 "type": "object" |
928 }, | 980 }, |
929 "Project": { | 981 "Ancestor": { |
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.", | 982 "description": "Identifying information for a single ancestor of a p
roject.", |
931 "id": "Project", | 983 "id": "Ancestor", |
932 "properties": { | 984 "properties": { |
933 "parent": { | 985 "resourceId": { |
934 "$ref": "ResourceId", | 986 "$ref": "ResourceId", |
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. The `parent` can be set on creation or using the\n`UpdateProjec
t` method; the end user must have the\n`resourcemanager.projects.create` permiss
ion on the parent.\n\nRead-write." | 987 "description": "Resource id of the ancestor." |
936 }, | |
937 "labels": { | |
938 "additionalProperties": { | |
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>\nRead-write.", | |
942 "type": "object" | |
943 }, | |
944 "lifecycleState": { | |
945 "description": "The Project lifecycle state.\n\nRead-only.", | |
946 "enum": [ | |
947 "LIFECYCLE_STATE_UNSPECIFIED", | |
948 "ACTIVE", | |
949 "DELETE_REQUESTED", | |
950 "DELETE_IN_PROGRESS" | |
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", | |
963 "type": "string" | |
964 }, | |
965 "name": { | |
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>\nRead-write.", | |
967 "type": "string" | |
968 }, | |
969 "projectNumber": { | |
970 "description": "The number uniquely identifying the project.
\n\nExample: <code>415104041262</code>\nRead-only.", | |
971 "format": "int64", | |
972 "type": "string" | |
973 }, | |
974 "projectId": { | |
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>\nRead-only after creation.", | |
976 "type": "string" | |
977 } | 988 } |
978 }, | 989 }, |
979 "type": "object" | 990 "type": "object" |
980 }, | |
981 "OrganizationOwner": { | |
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.", | |
983 "id": "OrganizationOwner", | |
984 "properties": { | |
985 "directoryCustomerId": { | |
986 "description": "The Google for Work customer id used in the
Directory API.", | |
987 "type": "string" | |
988 } | |
989 }, | |
990 "type": "object" | |
991 } | 991 } |
992 }, | 992 }, |
993 "servicePath": "", | 993 "servicePath": "", |
994 "title": "Google Cloud Resource Manager API", | 994 "title": "Google Cloud Resource Manager API", |
995 "version": "v1" | 995 "version": "v1" |
996 } | 996 } |
OLD | NEW |