Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(158)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/appengine__v1.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/androidpublisher__v2.json ('k') | discovery/googleapis/appstate__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services"
7 },
8 "https://www.googleapis.com/auth/appengine.admin": { 5 "https://www.googleapis.com/auth/appengine.admin": {
9 "description": "View and manage your applications deployed o n Google App Engine" 6 "description": "View and manage your applications deployed o n Google App Engine"
10 }, 7 },
11 "https://www.googleapis.com/auth/cloud-platform.read-only": { 8 "https://www.googleapis.com/auth/cloud-platform.read-only": {
12 "description": "View your data across Google Cloud Platform services" 9 "description": "View your data across Google Cloud Platform services"
10 },
11 "https://www.googleapis.com/auth/cloud-platform": {
12 "description": "View and manage your data across Google Clou d Platform services"
13 } 13 }
14 } 14 }
15 } 15 }
16 }, 16 },
17 "basePath": "", 17 "basePath": "",
18 "baseUrl": "https://appengine.googleapis.com/", 18 "baseUrl": "https://appengine.googleapis.com/",
19 "batchPath": "batch", 19 "batchPath": "batch",
20 "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", 20 "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
21 "discoveryVersion": "v1", 21 "discoveryVersion": "v1",
22 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", 22 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
23 "icons": { 23 "icons": {
24 "x16": "http://www.google.com/images/icons/product/search-16.gif", 24 "x16": "http://www.google.com/images/icons/product/search-16.gif",
25 "x32": "http://www.google.com/images/icons/product/search-32.gif" 25 "x32": "http://www.google.com/images/icons/product/search-32.gif"
26 }, 26 },
27 "id": "appengine:v1", 27 "id": "appengine:v1",
28 "kind": "discovery#restDescription", 28 "kind": "discovery#restDescription",
29 "name": "appengine", 29 "name": "appengine",
30 "ownerDomain": "google.com", 30 "ownerDomain": "google.com",
31 "ownerName": "Google", 31 "ownerName": "Google",
32 "parameters": { 32 "parameters": {
33 "access_token": {
34 "description": "OAuth access token.",
35 "location": "query",
36 "type": "string"
37 },
38 "key": {
39 "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.",
40 "location": "query",
41 "type": "string"
42 },
43 "quotaUser": {
44 "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.",
45 "location": "query",
46 "type": "string"
47 },
48 "pp": { 33 "pp": {
49 "default": "true", 34 "default": "true",
50 "description": "Pretty-print response.", 35 "description": "Pretty-print response.",
51 "location": "query", 36 "location": "query",
52 "type": "boolean" 37 "type": "boolean"
53 }, 38 },
54 "bearer_token": { 39 "bearer_token": {
55 "description": "OAuth bearer token.", 40 "description": "OAuth bearer token.",
56 "location": "query", 41 "location": "query",
57 "type": "string" 42 "type": "string"
58 }, 43 },
59 "oauth_token": { 44 "oauth_token": {
60 "description": "OAuth 2.0 token for the current user.", 45 "description": "OAuth 2.0 token for the current user.",
61 "location": "query", 46 "location": "query",
62 "type": "string" 47 "type": "string"
63 }, 48 },
64 "upload_protocol": { 49 "upload_protocol": {
65 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
66 "location": "query", 51 "location": "query",
67 "type": "string" 52 "type": "string"
68 }, 53 },
69 "prettyPrint": { 54 "prettyPrint": {
70 "default": "true", 55 "default": "true",
71 "description": "Returns response with indentations and line breaks." , 56 "description": "Returns response with indentations and line breaks." ,
72 "location": "query", 57 "location": "query",
73 "type": "boolean" 58 "type": "boolean"
74 }, 59 },
60 "fields": {
61 "description": "Selector specifying which fields to include in a par tial response.",
62 "location": "query",
63 "type": "string"
64 },
75 "uploadType": { 65 "uploadType": {
76 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 66 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
77 "location": "query", 67 "location": "query",
78 "type": "string" 68 "type": "string"
79 }, 69 },
80 "fields": {
81 "description": "Selector specifying which fields to include in a par tial response.",
82 "location": "query",
83 "type": "string"
84 },
85 "$.xgafv": { 70 "$.xgafv": {
86 "description": "V1 error format.", 71 "description": "V1 error format.",
87 "enum": [ 72 "enum": [
88 "1", 73 "1",
89 "2" 74 "2"
90 ], 75 ],
91 "enumDescriptions": [ 76 "enumDescriptions": [
92 "v1 error format", 77 "v1 error format",
93 "v2 error format" 78 "v2 error format"
94 ], 79 ],
(...skipping 13 matching lines...) Expand all
108 "media", 93 "media",
109 "proto" 94 "proto"
110 ], 95 ],
111 "enumDescriptions": [ 96 "enumDescriptions": [
112 "Responses with Content-Type of application/json", 97 "Responses with Content-Type of application/json",
113 "Media download with context-dependent Content-Type", 98 "Media download with context-dependent Content-Type",
114 "Responses with Content-Type of application/x-protobuf" 99 "Responses with Content-Type of application/x-protobuf"
115 ], 100 ],
116 "location": "query", 101 "location": "query",
117 "type": "string" 102 "type": "string"
103 },
104 "key": {
105 "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.",
106 "location": "query",
107 "type": "string"
108 },
109 "access_token": {
110 "description": "OAuth access token.",
111 "location": "query",
112 "type": "string"
113 },
114 "quotaUser": {
115 "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.",
116 "location": "query",
117 "type": "string"
118 } 118 }
119 }, 119 },
120 "protocol": "rest", 120 "protocol": "rest",
121 "resources": { 121 "resources": {
122 "apps": { 122 "apps": {
123 "methods": { 123 "methods": {
124 "create": {
125 "description": "Creates an App Engine application for a Goog le Cloud Platform project. Required fields:\nid - The ID of the target Cloud Pla tform project.\nlocation - The region (https://cloud.google.com/appengine/docs/l ocations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
126 "httpMethod": "POST",
127 "id": "appengine.apps.create",
128 "parameterOrder": [],
129 "parameters": {},
130 "path": "v1/apps",
131 "request": {
132 "$ref": "Application"
133 },
134 "response": {
135 "$ref": "Operation"
136 },
137 "scopes": [
138 "https://www.googleapis.com/auth/cloud-platform"
139 ]
140 },
141 "repair": { 124 "repair": {
142 "description": "Recreates the required App Engine features f or the specified App Engine application, for example a Cloud Storage bucket or A pp Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account .", 125 "description": "Recreates the required App Engine features f or the specified App Engine application, for example a Cloud Storage bucket or A pp Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account .",
143 "httpMethod": "POST", 126 "httpMethod": "POST",
144 "id": "appengine.apps.repair", 127 "id": "appengine.apps.repair",
145 "parameterOrder": [ 128 "parameterOrder": [
146 "appsId" 129 "appsId"
147 ], 130 ],
148 "parameters": { 131 "parameters": {
149 "appsId": { 132 "appsId": {
150 "description": "Part of `name`. Name of the applicat ion to repair. Example: apps/myapp", 133 "description": "Part of `name`. Name of the applicat ion to repair. Example: apps/myapp",
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after
213 }, 196 },
214 "path": "v1/apps/{appsId}", 197 "path": "v1/apps/{appsId}",
215 "response": { 198 "response": {
216 "$ref": "Application" 199 "$ref": "Application"
217 }, 200 },
218 "scopes": [ 201 "scopes": [
219 "https://www.googleapis.com/auth/appengine.admin", 202 "https://www.googleapis.com/auth/appengine.admin",
220 "https://www.googleapis.com/auth/cloud-platform", 203 "https://www.googleapis.com/auth/cloud-platform",
221 "https://www.googleapis.com/auth/cloud-platform.read-onl y" 204 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
222 ] 205 ]
206 },
207 "create": {
208 "description": "Creates an App Engine application for a Goog le Cloud Platform project. Required fields:\nid - The ID of the target Cloud Pla tform project.\nlocation - The region (https://cloud.google.com/appengine/docs/l ocations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
209 "httpMethod": "POST",
210 "id": "appengine.apps.create",
211 "parameterOrder": [],
212 "parameters": {},
213 "path": "v1/apps",
214 "request": {
215 "$ref": "Application"
216 },
217 "response": {
218 "$ref": "Operation"
219 },
220 "scopes": [
221 "https://www.googleapis.com/auth/cloud-platform"
222 ]
223 } 223 }
224 }, 224 },
225 "resources": { 225 "resources": {
226 "operations": {
227 "methods": {
228 "get": {
229 "description": "Gets the latest state of a long-runn ing operation. Clients can use this method to poll the operation result at inter vals as recommended by the API service.",
230 "httpMethod": "GET",
231 "id": "appengine.apps.operations.get",
232 "parameterOrder": [
233 "appsId",
234 "operationsId"
235 ],
236 "parameters": {
237 "appsId": {
238 "description": "Part of `name`. The name of the operation resource.",
239 "location": "path",
240 "required": true,
241 "type": "string"
242 },
243 "operationsId": {
244 "description": "Part of `name`. See document ation of `appsId`.",
245 "location": "path",
246 "required": true,
247 "type": "string"
248 }
249 },
250 "path": "v1/apps/{appsId}/operations/{operationsId}" ,
251 "response": {
252 "$ref": "Operation"
253 },
254 "scopes": [
255 "https://www.googleapis.com/auth/appengine.admin ",
256 "https://www.googleapis.com/auth/cloud-platform" ,
257 "https://www.googleapis.com/auth/cloud-platform. read-only"
258 ]
259 },
260 "list": {
261 "description": "Lists operations that match the spec ified filter in the request. If the server doesn't support this method, it retur ns UNIMPLEMENTED.NOTE: the name binding allows API services to override the bind ing to use different resource name schemes, such as users/*/operations. To overr ide the binding, API services can add a binding such as \"/v1/{name=users/*}/ope rations\" to their service configuration. For backwards compatibility, the defau lt name includes the operations collection id, however overriding users must ens ure the name binding is the parent resource, without the operations collection i d.",
262 "httpMethod": "GET",
263 "id": "appengine.apps.operations.list",
264 "parameterOrder": [
265 "appsId"
266 ],
267 "parameters": {
268 "pageToken": {
269 "description": "The standard list page token .",
270 "location": "query",
271 "type": "string"
272 },
273 "appsId": {
274 "description": "Part of `name`. The name of the operation's parent resource.",
275 "location": "path",
276 "required": true,
277 "type": "string"
278 },
279 "pageSize": {
280 "description": "The standard list page size. ",
281 "format": "int32",
282 "location": "query",
283 "type": "integer"
284 },
285 "filter": {
286 "description": "The standard list filter.",
287 "location": "query",
288 "type": "string"
289 }
290 },
291 "path": "v1/apps/{appsId}/operations",
292 "response": {
293 "$ref": "ListOperationsResponse"
294 },
295 "scopes": [
296 "https://www.googleapis.com/auth/appengine.admin ",
297 "https://www.googleapis.com/auth/cloud-platform" ,
298 "https://www.googleapis.com/auth/cloud-platform. read-only"
299 ]
300 }
301 }
302 },
303 "locations": { 226 "locations": {
304 "methods": { 227 "methods": {
305 "get": { 228 "get": {
306 "description": "Get information about a location.", 229 "description": "Get information about a location.",
307 "httpMethod": "GET", 230 "httpMethod": "GET",
308 "id": "appengine.apps.locations.get", 231 "id": "appengine.apps.locations.get",
309 "parameterOrder": [ 232 "parameterOrder": [
310 "appsId", 233 "appsId",
311 "locationsId" 234 "locationsId"
312 ], 235 ],
(...skipping 22 matching lines...) Expand all
335 ] 258 ]
336 }, 259 },
337 "list": { 260 "list": {
338 "description": "Lists information about the supporte d locations for this service.", 261 "description": "Lists information about the supporte d locations for this service.",
339 "httpMethod": "GET", 262 "httpMethod": "GET",
340 "id": "appengine.apps.locations.list", 263 "id": "appengine.apps.locations.list",
341 "parameterOrder": [ 264 "parameterOrder": [
342 "appsId" 265 "appsId"
343 ], 266 ],
344 "parameters": { 267 "parameters": {
268 "pageSize": {
269 "description": "The standard list page size. ",
270 "format": "int32",
271 "location": "query",
272 "type": "integer"
273 },
345 "filter": { 274 "filter": {
346 "description": "The standard list filter.", 275 "description": "The standard list filter.",
347 "location": "query", 276 "location": "query",
348 "type": "string" 277 "type": "string"
349 }, 278 },
350 "pageToken": { 279 "pageToken": {
351 "description": "The standard list page token .", 280 "description": "The standard list page token .",
352 "location": "query", 281 "location": "query",
353 "type": "string" 282 "type": "string"
354 }, 283 },
355 "appsId": { 284 "appsId": {
356 "description": "Part of `name`. The resource that owns the locations collection, if applicable.", 285 "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
357 "location": "path", 286 "location": "path",
358 "required": true, 287 "required": true,
359 "type": "string" 288 "type": "string"
360 },
361 "pageSize": {
362 "description": "The standard list page size. ",
363 "format": "int32",
364 "location": "query",
365 "type": "integer"
366 } 289 }
367 }, 290 },
368 "path": "v1/apps/{appsId}/locations", 291 "path": "v1/apps/{appsId}/locations",
369 "response": { 292 "response": {
370 "$ref": "ListLocationsResponse" 293 "$ref": "ListLocationsResponse"
371 }, 294 },
372 "scopes": [ 295 "scopes": [
373 "https://www.googleapis.com/auth/appengine.admin ", 296 "https://www.googleapis.com/auth/appengine.admin ",
374 "https://www.googleapis.com/auth/cloud-platform" , 297 "https://www.googleapis.com/auth/cloud-platform" ,
375 "https://www.googleapis.com/auth/cloud-platform. read-only" 298 "https://www.googleapis.com/auth/cloud-platform. read-only"
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
411 }, 334 },
412 "patch": { 335 "patch": {
413 "description": "Updates the configuration of the spe cified service.", 336 "description": "Updates the configuration of the spe cified service.",
414 "httpMethod": "PATCH", 337 "httpMethod": "PATCH",
415 "id": "appengine.apps.services.patch", 338 "id": "appengine.apps.services.patch",
416 "parameterOrder": [ 339 "parameterOrder": [
417 "appsId", 340 "appsId",
418 "servicesId" 341 "servicesId"
419 ], 342 ],
420 "parameters": { 343 "parameters": {
344 "appsId": {
345 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
346 "location": "path",
347 "required": true,
348 "type": "string"
349 },
350 "migrateTraffic": {
351 "description": "Set to true to gradually shi ft traffic to one or more versions that you specify. By default, traffic is shif ted immediately. For gradual traffic migration, the target versions must be loca ted within instances that are configured for both warmup requests (https://cloud .google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#in boundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs /admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference /rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic m igration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/adm in-api/migrating-splitting-traffic).",
352 "location": "query",
353 "type": "boolean"
354 },
421 "updateMask": { 355 "updateMask": {
422 "description": "Standard field mask for the set of fields to be updated.", 356 "description": "Standard field mask for the set of fields to be updated.",
423 "format": "google-fieldmask", 357 "format": "google-fieldmask",
424 "location": "query", 358 "location": "query",
425 "type": "string" 359 "type": "string"
426 }, 360 },
427 "servicesId": { 361 "servicesId": {
428 "description": "Part of `name`. See document ation of `appsId`.", 362 "description": "Part of `name`. See document ation of `appsId`.",
429 "location": "path", 363 "location": "path",
430 "required": true, 364 "required": true,
431 "type": "string" 365 "type": "string"
432 },
433 "appsId": {
434 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
435 "location": "path",
436 "required": true,
437 "type": "string"
438 },
439 "migrateTraffic": {
440 "description": "Set to true to gradually shi ft traffic to one or more versions that you specify. By default, traffic is shif ted immediately. For gradual traffic migration, the target versions must be loca ted within instances that are configured for both warmup requests (https://cloud .google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#in boundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs /admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference /rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic m igration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/adm in-api/migrating-splitting-traffic).",
441 "location": "query",
442 "type": "boolean"
443 } 366 }
444 }, 367 },
445 "path": "v1/apps/{appsId}/services/{servicesId}", 368 "path": "v1/apps/{appsId}/services/{servicesId}",
446 "request": { 369 "request": {
447 "$ref": "Service" 370 "$ref": "Service"
448 }, 371 },
449 "response": { 372 "response": {
450 "$ref": "Operation" 373 "$ref": "Operation"
451 }, 374 },
452 "scopes": [ 375 "scopes": [
(...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after
565 "patch": { 488 "patch": {
566 "description": "Updates the specified Versio n resource. You can specify the following fields depending on the App Engine env ironment and type of scaling that the version resource uses:\nserving_status (ht tps://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services. versions#Version.FIELDS.serving_status): For Version resources that use basic s caling, manual scaling, or run in the App Engine flexible environment.\ninstanc e_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/app s.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instance s (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.serv ices.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_s caling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/ref erence/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Ve rsion resources that use automatic scaling and run in the App Engine standard e nvironment.", 489 "description": "Updates the specified Versio n resource. You can specify the following fields depending on the App Engine env ironment and type of scaling that the version resource uses:\nserving_status (ht tps://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services. versions#Version.FIELDS.serving_status): For Version resources that use basic s caling, manual scaling, or run in the App Engine flexible environment.\ninstanc e_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/app s.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instance s (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.serv ices.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_s caling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/ref erence/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Ve rsion resources that use automatic scaling and run in the App Engine standard e nvironment.",
567 "httpMethod": "PATCH", 490 "httpMethod": "PATCH",
568 "id": "appengine.apps.services.versions.patc h", 491 "id": "appengine.apps.services.versions.patc h",
569 "parameterOrder": [ 492 "parameterOrder": [
570 "appsId", 493 "appsId",
571 "servicesId", 494 "servicesId",
572 "versionsId" 495 "versionsId"
573 ], 496 ],
574 "parameters": { 497 "parameters": {
498 "versionsId": {
499 "description": "Part of `name`. See documentation of `appsId`.",
500 "location": "path",
501 "required": true,
502 "type": "string"
503 },
575 "updateMask": { 504 "updateMask": {
576 "description": "Standard field mask for the set of fields to be updated.", 505 "description": "Standard field mask for the set of fields to be updated.",
577 "format": "google-fieldmask", 506 "format": "google-fieldmask",
578 "location": "query", 507 "location": "query",
579 "type": "string" 508 "type": "string"
580 }, 509 },
581 "servicesId": { 510 "servicesId": {
582 "description": "Part of `name`. See documentation of `appsId`.", 511 "description": "Part of `name`. See documentation of `appsId`.",
583 "location": "path", 512 "location": "path",
584 "required": true, 513 "required": true,
585 "type": "string" 514 "type": "string"
586 }, 515 },
587 "appsId": { 516 "appsId": {
588 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", 517 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
589 "location": "path", 518 "location": "path",
590 "required": true, 519 "required": true,
591 "type": "string" 520 "type": "string"
592 },
593 "versionsId": {
594 "description": "Part of `name`. See documentation of `appsId`.",
595 "location": "path",
596 "required": true,
597 "type": "string"
598 } 521 }
599 }, 522 },
600 "path": "v1/apps/{appsId}/services/{services Id}/versions/{versionsId}", 523 "path": "v1/apps/{appsId}/services/{services Id}/versions/{versionsId}",
601 "request": { 524 "request": {
602 "$ref": "Version" 525 "$ref": "Version"
603 }, 526 },
604 "response": { 527 "response": {
605 "$ref": "Operation" 528 "$ref": "Operation"
606 }, 529 },
607 "scopes": [ 530 "scopes": [
(...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after
738 "$ref": "Operation" 661 "$ref": "Operation"
739 }, 662 },
740 "scopes": [ 663 "scopes": [
741 "https://www.googleapis.com/auth/cloud-p latform" 664 "https://www.googleapis.com/auth/cloud-p latform"
742 ] 665 ]
743 } 666 }
744 }, 667 },
745 "resources": { 668 "resources": {
746 "instances": { 669 "instances": {
747 "methods": { 670 "methods": {
748 "delete": { 671 "debug": {
749 "description": "Stops a running inst ance.", 672 "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continu es to serve live traffic. You should delete the instance when you are done debug ging and then allow the system to take over and determine if another instance sh ould be started.Only applicable for instances in App Engine flexible environment .",
750 "httpMethod": "DELETE", 673 "httpMethod": "POST",
751 "id": "appengine.apps.services.versi ons.instances.delete", 674 "id": "appengine.apps.services.versi ons.instances.debug",
752 "parameterOrder": [ 675 "parameterOrder": [
753 "appsId", 676 "appsId",
754 "servicesId", 677 "servicesId",
755 "versionsId", 678 "versionsId",
756 "instancesId" 679 "instancesId"
757 ], 680 ],
758 "parameters": { 681 "parameters": {
759 "versionsId": {
760 "description": "Part of `nam e`. See documentation of `appsId`.",
761 "location": "path",
762 "required": true,
763 "type": "string"
764 },
765 "servicesId": { 682 "servicesId": {
766 "description": "Part of `nam e`. See documentation of `appsId`.", 683 "description": "Part of `nam e`. See documentation of `appsId`.",
767 "location": "path", 684 "location": "path",
768 "required": true, 685 "required": true,
769 "type": "string" 686 "type": "string"
770 }, 687 },
771 "instancesId": { 688 "instancesId": {
772 "description": "Part of `nam e`. See documentation of `appsId`.", 689 "description": "Part of `nam e`. See documentation of `appsId`.",
773 "location": "path", 690 "location": "path",
774 "required": true, 691 "required": true,
775 "type": "string" 692 "type": "string"
776 }, 693 },
777 "appsId": { 694 "appsId": {
778 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.", 695 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.",
779 "location": "path", 696 "location": "path",
780 "required": true, 697 "required": true,
781 "type": "string" 698 "type": "string"
699 },
700 "versionsId": {
701 "description": "Part of `nam e`. See documentation of `appsId`.",
702 "location": "path",
703 "required": true,
704 "type": "string"
782 } 705 }
783 }, 706 },
784 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}", 707 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
708 "request": {
709 "$ref": "DebugInstanceRequest"
710 },
785 "response": { 711 "response": {
786 "$ref": "Operation" 712 "$ref": "Operation"
787 }, 713 },
788 "scopes": [ 714 "scopes": [
789 "https://www.googleapis.com/auth /cloud-platform" 715 "https://www.googleapis.com/auth /cloud-platform"
790 ] 716 ]
791 }, 717 },
792 "get": { 718 "delete": {
793 "description": "Gets instance inform ation.", 719 "description": "Stops a running inst ance.",
794 "httpMethod": "GET", 720 "httpMethod": "DELETE",
795 "id": "appengine.apps.services.versi ons.instances.get", 721 "id": "appengine.apps.services.versi ons.instances.delete",
796 "parameterOrder": [ 722 "parameterOrder": [
797 "appsId", 723 "appsId",
798 "servicesId", 724 "servicesId",
799 "versionsId", 725 "versionsId",
800 "instancesId" 726 "instancesId"
801 ], 727 ],
802 "parameters": { 728 "parameters": {
729 "servicesId": {
730 "description": "Part of `nam e`. See documentation of `appsId`.",
731 "location": "path",
732 "required": true,
733 "type": "string"
734 },
803 "instancesId": { 735 "instancesId": {
804 "description": "Part of `nam e`. See documentation of `appsId`.", 736 "description": "Part of `nam e`. See documentation of `appsId`.",
805 "location": "path", 737 "location": "path",
806 "required": true, 738 "required": true,
807 "type": "string" 739 "type": "string"
808 }, 740 },
809 "appsId": { 741 "appsId": {
810 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.", 742 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.",
811 "location": "path", 743 "location": "path",
812 "required": true, 744 "required": true,
813 "type": "string" 745 "type": "string"
814 }, 746 },
815 "versionsId": { 747 "versionsId": {
816 "description": "Part of `nam e`. See documentation of `appsId`.", 748 "description": "Part of `nam e`. See documentation of `appsId`.",
817 "location": "path", 749 "location": "path",
818 "required": true, 750 "required": true,
819 "type": "string"
820 },
821 "servicesId": {
822 "description": "Part of `nam e`. See documentation of `appsId`.",
823 "location": "path",
824 "required": true,
825 "type": "string" 751 "type": "string"
826 } 752 }
827 }, 753 },
828 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}", 754 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}",
829 "response": { 755 "response": {
756 "$ref": "Operation"
757 },
758 "scopes": [
759 "https://www.googleapis.com/auth /cloud-platform"
760 ]
761 },
762 "get": {
763 "description": "Gets instance inform ation.",
764 "httpMethod": "GET",
765 "id": "appengine.apps.services.versi ons.instances.get",
766 "parameterOrder": [
767 "appsId",
768 "servicesId",
769 "versionsId",
770 "instancesId"
771 ],
772 "parameters": {
773 "servicesId": {
774 "description": "Part of `nam e`. See documentation of `appsId`.",
775 "location": "path",
776 "required": true,
777 "type": "string"
778 },
779 "instancesId": {
780 "description": "Part of `nam e`. See documentation of `appsId`.",
781 "location": "path",
782 "required": true,
783 "type": "string"
784 },
785 "appsId": {
786 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.",
787 "location": "path",
788 "required": true,
789 "type": "string"
790 },
791 "versionsId": {
792 "description": "Part of `nam e`. See documentation of `appsId`.",
793 "location": "path",
794 "required": true,
795 "type": "string"
796 }
797 },
798 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}",
799 "response": {
830 "$ref": "Instance" 800 "$ref": "Instance"
831 }, 801 },
832 "scopes": [ 802 "scopes": [
833 "https://www.googleapis.com/auth /appengine.admin", 803 "https://www.googleapis.com/auth /appengine.admin",
834 "https://www.googleapis.com/auth /cloud-platform",
835 "https://www.googleapis.com/auth /cloud-platform.read-only"
836 ]
837 },
838 "list": {
839 "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackd river Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/pro jects.timeSeries/list).",
840 "httpMethod": "GET",
841 "id": "appengine.apps.services.versi ons.instances.list",
842 "parameterOrder": [
843 "appsId",
844 "servicesId",
845 "versionsId"
846 ],
847 "parameters": {
848 "pageSize": {
849 "description": "Maximum resu lts to return per page.",
850 "format": "int32",
851 "location": "query",
852 "type": "integer"
853 },
854 "versionsId": {
855 "description": "Part of `par ent`. See documentation of `appsId`.",
856 "location": "path",
857 "required": true,
858 "type": "string"
859 },
860 "servicesId": {
861 "description": "Part of `par ent`. See documentation of `appsId`.",
862 "location": "path",
863 "required": true,
864 "type": "string"
865 },
866 "pageToken": {
867 "description": "Continuation token for fetching the next page of results.",
868 "location": "query",
869 "type": "string"
870 },
871 "appsId": {
872 "description": "Part of `par ent`. Name of the parent Version resource. Example: apps/myapp/services/default/ versions/v1.",
873 "location": "path",
874 "required": true,
875 "type": "string"
876 }
877 },
878 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances",
879 "response": {
880 "$ref": "ListInstancesResponse"
881 },
882 "scopes": [
883 "https://www.googleapis.com/auth /appengine.admin",
884 "https://www.googleapis.com/auth /cloud-platform", 804 "https://www.googleapis.com/auth /cloud-platform",
885 "https://www.googleapis.com/auth /cloud-platform.read-only" 805 "https://www.googleapis.com/auth /cloud-platform.read-only"
886 ] 806 ]
887 }, 807 },
888 "debug": { 808 "list": {
889 "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continu es to serve live traffic. You should delete the instance when you are done debug ging and then allow the system to take over and determine if another instance sh ould be started.Only applicable for instances in App Engine flexible environment .", 809 "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackd river Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/pro jects.timeSeries/list).",
890 "httpMethod": "POST", 810 "httpMethod": "GET",
891 "id": "appengine.apps.services.versi ons.instances.debug", 811 "id": "appengine.apps.services.versi ons.instances.list",
892 "parameterOrder": [ 812 "parameterOrder": [
893 "appsId", 813 "appsId",
894 "servicesId", 814 "servicesId",
895 "versionsId", 815 "versionsId"
896 "instancesId"
897 ], 816 ],
898 "parameters": { 817 "parameters": {
899 "servicesId": { 818 "pageToken": {
900 "description": "Part of `nam e`. See documentation of `appsId`.", 819 "description": "Continuation token for fetching the next page of results.",
820 "location": "query",
821 "type": "string"
822 },
823 "appsId": {
824 "description": "Part of `par ent`. Name of the parent Version resource. Example: apps/myapp/services/default/ versions/v1.",
901 "location": "path", 825 "location": "path",
902 "required": true, 826 "required": true,
903 "type": "string" 827 "type": "string"
904 }, 828 },
905 "instancesId": { 829 "pageSize": {
906 "description": "Part of `nam e`. See documentation of `appsId`.", 830 "description": "Maximum resu lts to return per page.",
831 "format": "int32",
832 "location": "query",
833 "type": "integer"
834 },
835 "versionsId": {
836 "description": "Part of `par ent`. See documentation of `appsId`.",
907 "location": "path", 837 "location": "path",
908 "required": true, 838 "required": true,
909 "type": "string" 839 "type": "string"
910 }, 840 },
911 "appsId": { 841 "servicesId": {
912 "description": "Part of `nam e`. Name of the resource requested. Example: apps/myapp/services/default/version s/v1/instances/instance-1.", 842 "description": "Part of `par ent`. See documentation of `appsId`.",
913 "location": "path",
914 "required": true,
915 "type": "string"
916 },
917 "versionsId": {
918 "description": "Part of `nam e`. See documentation of `appsId`.",
919 "location": "path", 843 "location": "path",
920 "required": true, 844 "required": true,
921 "type": "string" 845 "type": "string"
922 } 846 }
923 }, 847 },
924 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances/{instancesId}:debug", 848 "path": "v1/apps/{appsId}/services/{ servicesId}/versions/{versionsId}/instances",
925 "request": {
926 "$ref": "DebugInstanceRequest"
927 },
928 "response": { 849 "response": {
929 "$ref": "Operation" 850 "$ref": "ListInstancesResponse"
930 }, 851 },
931 "scopes": [ 852 "scopes": [
932 "https://www.googleapis.com/auth /cloud-platform" 853 "https://www.googleapis.com/auth /appengine.admin",
854 "https://www.googleapis.com/auth /cloud-platform",
855 "https://www.googleapis.com/auth /cloud-platform.read-only"
933 ] 856 ]
934 } 857 }
935 } 858 }
936 } 859 }
937 } 860 }
938 } 861 }
939 } 862 }
863 },
864 "operations": {
865 "methods": {
866 "get": {
867 "description": "Gets the latest state of a long-runn ing operation. Clients can use this method to poll the operation result at inter vals as recommended by the API service.",
868 "httpMethod": "GET",
869 "id": "appengine.apps.operations.get",
870 "parameterOrder": [
871 "appsId",
872 "operationsId"
873 ],
874 "parameters": {
875 "operationsId": {
876 "description": "Part of `name`. See document ation of `appsId`.",
877 "location": "path",
878 "required": true,
879 "type": "string"
880 },
881 "appsId": {
882 "description": "Part of `name`. The name of the operation resource.",
883 "location": "path",
884 "required": true,
885 "type": "string"
886 }
887 },
888 "path": "v1/apps/{appsId}/operations/{operationsId}" ,
889 "response": {
890 "$ref": "Operation"
891 },
892 "scopes": [
893 "https://www.googleapis.com/auth/appengine.admin ",
894 "https://www.googleapis.com/auth/cloud-platform" ,
895 "https://www.googleapis.com/auth/cloud-platform. read-only"
896 ]
897 },
898 "list": {
899 "description": "Lists operations that match the spec ified filter in the request. If the server doesn't support this method, it retur ns UNIMPLEMENTED.NOTE: the name binding allows API services to override the bind ing to use different resource name schemes, such as users/*/operations. To overr ide the binding, API services can add a binding such as \"/v1/{name=users/*}/ope rations\" to their service configuration. For backwards compatibility, the defau lt name includes the operations collection id, however overriding users must ens ure the name binding is the parent resource, without the operations collection i d.",
900 "httpMethod": "GET",
901 "id": "appengine.apps.operations.list",
902 "parameterOrder": [
903 "appsId"
904 ],
905 "parameters": {
906 "filter": {
907 "description": "The standard list filter.",
908 "location": "query",
909 "type": "string"
910 },
911 "pageToken": {
912 "description": "The standard list page token .",
913 "location": "query",
914 "type": "string"
915 },
916 "appsId": {
917 "description": "Part of `name`. The name of the operation's parent resource.",
918 "location": "path",
919 "required": true,
920 "type": "string"
921 },
922 "pageSize": {
923 "description": "The standard list page size. ",
924 "format": "int32",
925 "location": "query",
926 "type": "integer"
927 }
928 },
929 "path": "v1/apps/{appsId}/operations",
930 "response": {
931 "$ref": "ListOperationsResponse"
932 },
933 "scopes": [
934 "https://www.googleapis.com/auth/appengine.admin ",
935 "https://www.googleapis.com/auth/cloud-platform" ,
936 "https://www.googleapis.com/auth/cloud-platform. read-only"
937 ]
938 }
939 }
940 } 940 }
941 } 941 }
942 } 942 }
943 }, 943 },
944 "revision": "20170721", 944 "revision": "20170811",
945 "rootUrl": "https://appengine.googleapis.com/", 945 "rootUrl": "https://appengine.googleapis.com/",
946 "schemas": { 946 "schemas": {
947 "UrlMap": { 947 "DebugInstanceRequest": {
948 "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", 948 "description": "Request message for Instances.DebugInstance.",
949 "id": "UrlMap", 949 "id": "DebugInstanceRequest",
950 "properties": { 950 "properties": {
951 "script": { 951 "sshKey": {
952 "$ref": "ScriptHandler", 952 "description": "Public SSH key to add to the instance. Examp les:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/ docs/instances/adding-removing-ssh-keys).",
953 "description": "Executes a script to handle the request that matches this URL pattern." 953 "type": "string"
954 }, 954 }
955 "urlRegex": { 955 },
956 "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain gr oupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", 956 "type": "object"
957 "type": "string" 957 },
958 }, 958 "OperationMetadataV1Beta5": {
959 "login": { 959 "description": "Metadata for the given google.longrunning.Operation. ",
960 "description": "Level of login required to access this resou rce.", 960 "id": "OperationMetadataV1Beta5",
961 "properties": {
962 "method": {
963 "description": "API method name that initiated this operatio n. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
964 "type": "string"
965 },
966 "insertTime": {
967 "description": "Timestamp that this operation was created.@O utputOnly",
968 "format": "google-datetime",
969 "type": "string"
970 },
971 "endTime": {
972 "description": "Timestamp that this operation completed.@Out putOnly",
973 "format": "google-datetime",
974 "type": "string"
975 },
976 "target": {
977 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
978 "type": "string"
979 },
980 "user": {
981 "description": "User who requested this operation.@OutputOnl y",
982 "type": "string"
983 }
984 },
985 "type": "object"
986 },
987 "Version": {
988 "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
989 "id": "Version",
990 "properties": {
991 "automaticScaling": {
992 "$ref": "AutomaticScaling",
993 "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
994 },
995 "diskUsageBytes": {
996 "description": "Total size in bytes of all the files that ar e included in this version and curerntly hosted on the App Engine disk.@OutputOn ly",
997 "format": "int64",
998 "type": "string"
999 },
1000 "healthCheck": {
1001 "$ref": "HealthCheck",
1002 "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicabl e for VM runtimes.Only returned in GET requests if view=FULL is set."
1003 },
1004 "threadsafe": {
1005 "description": "Whether multiple requests can be dispatched to this version at once.",
1006 "type": "boolean"
1007 },
1008 "readinessCheck": {
1009 "$ref": "ReadinessCheck",
1010 "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Onl y returned in GET requests if view=FULL is set."
1011 },
1012 "manualScaling": {
1013 "$ref": "ManualScaling",
1014 "description": "A service with manual scaling runs continuou sly, allowing you to perform complex initialization and rely on the state of its memory over time."
1015 },
1016 "name": {
1017 "description": "Full path to the Version resource in the API . Example: apps/myapp/services/default/versions/v1.@OutputOnly",
1018 "type": "string"
1019 },
1020 "apiConfig": {
1021 "$ref": "ApiConfigHandler",
1022 "description": "Serving configuration for Google Cloud Endpo ints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned i n GET requests if view=FULL is set."
1023 },
1024 "endpointsApiService": {
1025 "$ref": "EndpointsApiService",
1026 "description": "Cloud Endpoints configuration.If endpoints_a pi_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
1027 },
1028 "vm": {
1029 "description": "Whether to deploy this version in a containe r on a virtual machine.",
1030 "type": "boolean"
1031 },
1032 "versionUrl": {
1033 "description": "Serving URL for this version. Example: \"htt ps://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
1034 "type": "string"
1035 },
1036 "instanceClass": {
1037 "description": "Instance class that is used to run this vers ion. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or Ba sicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
1038 "type": "string"
1039 },
1040 "servingStatus": {
1041 "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_S TATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
961 "enum": [ 1042 "enum": [
962 "LOGIN_UNSPECIFIED", 1043 "SERVING_STATUS_UNSPECIFIED",
963 "LOGIN_OPTIONAL", 1044 "SERVING",
964 "LOGIN_ADMIN", 1045 "STOPPED"
965 "LOGIN_REQUIRED"
966 ],
967 "enumDescriptions": [
968 "Not specified. LOGIN_OPTIONAL is assumed.",
969 "Does not require that the user is signed in.",
970 "If the user is not signed in, the auth_fail_action is t aken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an ad ministrator, the handler proceeds.",
971 "If the user has signed in, the handler proceeds normall y. Otherwise, the auth_fail_action is taken."
972 ],
973 "type": "string"
974 },
975 "apiEndpoint": {
976 "$ref": "ApiEndpointHandler",
977 "description": "Uses API Endpoints to handle requests."
978 },
979 "staticFiles": {
980 "$ref": "StaticFilesHandler",
981 "description": "Returns the contents of a file, such as an i mage, as the response."
982 },
983 "redirectHttpResponseCode": {
984 "description": "30x code to use when performing redirects fo r the secure field. Defaults to 302.",
985 "enum": [
986 "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
987 "REDIRECT_HTTP_RESPONSE_CODE_301",
988 "REDIRECT_HTTP_RESPONSE_CODE_302",
989 "REDIRECT_HTTP_RESPONSE_CODE_303",
990 "REDIRECT_HTTP_RESPONSE_CODE_307"
991 ],
992 "enumDescriptions": [
993 "Not specified. 302 is assumed.",
994 "301 Moved Permanently code.",
995 "302 Moved Temporarily code.",
996 "303 See Other code.",
997 "307 Temporary Redirect code."
998 ],
999 "type": "string"
1000 },
1001 "securityLevel": {
1002 "description": "Security (HTTPS) enforcement for this URL.",
1003 "enum": [
1004 "SECURE_UNSPECIFIED",
1005 "SECURE_DEFAULT",
1006 "SECURE_NEVER",
1007 "SECURE_OPTIONAL",
1008 "SECURE_ALWAYS"
1009 ], 1046 ],
1010 "enumDescriptions": [ 1047 "enumDescriptions": [
1011 "Not specified.", 1048 "Not specified.",
1012 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used, and respond accordingly.", 1049 "Currently serving. Instances are created according to t he scaling settings of the version.",
1013 "Requests for a URL that match this handler that use HTT PS are automatically redirected to the HTTP equivalent URL.", 1050 "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
1014 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used and respond accordingly.",
1015 "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Quer y parameters are reserved for the redirect."
1016 ], 1051 ],
1017 "type": "string" 1052 "type": "string"
1018 }, 1053 },
1019 "authFailAction": { 1054 "deployment": {
1020 "description": "Action to take when users access resources t hat require authentication. Defaults to redirect.", 1055 "$ref": "Deployment",
1056 "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
1057 },
1058 "runtimeApiVersion": {
1059 "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud .google.com/appengine/docs/standard/<language>/config/appref",
1060 "type": "string"
1061 },
1062 "createTime": {
1063 "description": "Time that this version was created.@OutputOn ly",
1064 "format": "google-datetime",
1065 "type": "string"
1066 },
1067 "resources": {
1068 "$ref": "Resources",
1069 "description": "Machine resources for this version. Only app licable for VM runtimes."
1070 },
1071 "inboundServices": {
1072 "description": "Before an application can receive email or X MPP messages, the application must be configured to enable the service.",
1073 "enumDescriptions": [
1074 "Not specified.",
1075 "Allows an application to receive mail.",
1076 "Allows an application to receive email-bound notificati ons.",
1077 "Allows an application to receive error stanzas.",
1078 "Allows an application to receive instant messages.",
1079 "Allows an application to receive user subscription POST s.",
1080 "Allows an application to receive a user's chat presence .",
1081 "Registers an application for notifications when a clien t connects or disconnects from a channel.",
1082 "Enables warmup requests."
1083 ],
1084 "items": {
1085 "enum": [
1086 "INBOUND_SERVICE_UNSPECIFIED",
1087 "INBOUND_SERVICE_MAIL",
1088 "INBOUND_SERVICE_MAIL_BOUNCE",
1089 "INBOUND_SERVICE_XMPP_ERROR",
1090 "INBOUND_SERVICE_XMPP_MESSAGE",
1091 "INBOUND_SERVICE_XMPP_SUBSCRIBE",
1092 "INBOUND_SERVICE_XMPP_PRESENCE",
1093 "INBOUND_SERVICE_CHANNEL_PRESENCE",
1094 "INBOUND_SERVICE_WARMUP"
1095 ],
1096 "type": "string"
1097 },
1098 "type": "array"
1099 },
1100 "errorHandlers": {
1101 "description": "Custom static error pages. Limited to 10KB p er page.Only returned in GET requests if view=FULL is set.",
1102 "items": {
1103 "$ref": "ErrorHandler"
1104 },
1105 "type": "array"
1106 },
1107 "defaultExpiration": {
1108 "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHan dler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.s ervices.versions#staticfileshandler) does not specify its own expiration time.On ly returned in GET requests if view=FULL is set.",
1109 "format": "google-duration",
1110 "type": "string"
1111 },
1112 "libraries": {
1113 "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
1114 "items": {
1115 "$ref": "Library"
1116 },
1117 "type": "array"
1118 },
1119 "nobuildFilesRegex": {
1120 "description": "Files that match this pattern will not be bu ilt into this version. Only applicable for Go runtimes.Only returned in GET requ ests if view=FULL is set.",
1121 "type": "string"
1122 },
1123 "basicScaling": {
1124 "$ref": "BasicScaling",
1125 "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned do wn when the app becomes idle. Basic scaling is ideal for work that is intermitte nt or driven by user activity."
1126 },
1127 "runtime": {
1128 "description": "Desired runtime. Example: python27.",
1129 "type": "string"
1130 },
1131 "createdBy": {
1132 "description": "Email address of the user who created this v ersion.@OutputOnly",
1133 "type": "string"
1134 },
1135 "id": {
1136 "description": "Relative name of the version within the serv ice. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \ "ah-\".",
1137 "type": "string"
1138 },
1139 "envVariables": {
1140 "additionalProperties": {
1141 "type": "string"
1142 },
1143 "description": "Environment variables available to the appli cation.Only returned in GET requests if view=FULL is set.",
1144 "type": "object"
1145 },
1146 "livenessCheck": {
1147 "$ref": "LivenessCheck",
1148 "description": "Configures liveness health checking for VM i nstances. Unhealthy instances are stopped and replaced with new instancesOnly re turned in GET requests if view=FULL is set."
1149 },
1150 "network": {
1151 "$ref": "Network",
1152 "description": "Extra network settings. Only applicable for App Engine flexible environment versions."
1153 },
1154 "betaSettings": {
1155 "additionalProperties": {
1156 "type": "string"
1157 },
1158 "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
1159 "type": "object"
1160 },
1161 "env": {
1162 "description": "App Engine execution environment for this ve rsion.Defaults to standard.",
1163 "type": "string"
1164 },
1165 "handlers": {
1166 "description": "An ordered list of URL-matching patterns tha t should be applied to incoming requests. The first matching URL handles the req uest and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
1167 "items": {
1168 "$ref": "UrlMap"
1169 },
1170 "type": "array"
1171 }
1172 },
1173 "type": "object"
1174 },
1175 "RepairApplicationRequest": {
1176 "description": "Request message for 'Applications.RepairApplication' .",
1177 "id": "RepairApplicationRequest",
1178 "properties": {},
1179 "type": "object"
1180 },
1181 "ScriptHandler": {
1182 "description": "Executes a script to handle the request that matches the URL pattern.",
1183 "id": "ScriptHandler",
1184 "properties": {
1185 "scriptPath": {
1186 "description": "Path to the script from the application root directory.",
1187 "type": "string"
1188 }
1189 },
1190 "type": "object"
1191 },
1192 "FileInfo": {
1193 "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
1194 "id": "FileInfo",
1195 "properties": {
1196 "sha1Sum": {
1197 "description": "The SHA1 hash of the file, in hex.",
1198 "type": "string"
1199 },
1200 "mimeType": {
1201 "description": "The MIME type of the file.Defaults to the va lue from Google Cloud Storage.",
1202 "type": "string"
1203 },
1204 "sourceUrl": {
1205 "description": "URL source to use to fetch this file. Must b e a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.goo gleapis.com/<bucket>/<object>'.",
1206 "type": "string"
1207 }
1208 },
1209 "type": "object"
1210 },
1211 "OperationMetadataExperimental": {
1212 "description": "Metadata for the given google.longrunning.Operation. ",
1213 "id": "OperationMetadataExperimental",
1214 "properties": {
1215 "insertTime": {
1216 "description": "Time that this operation was created.@Output Only",
1217 "format": "google-datetime",
1218 "type": "string"
1219 },
1220 "endTime": {
1221 "description": "Time that this operation completed.@OutputOn ly",
1222 "format": "google-datetime",
1223 "type": "string"
1224 },
1225 "target": {
1226 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
1227 "type": "string"
1228 },
1229 "user": {
1230 "description": "User who requested this operation.@OutputOnl y",
1231 "type": "string"
1232 },
1233 "method": {
1234 "description": "API method that initiated this operation. Ex ample: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnl y",
1235 "type": "string"
1236 }
1237 },
1238 "type": "object"
1239 },
1240 "TrafficSplit": {
1241 "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is ass igned to versions.",
1242 "id": "TrafficSplit",
1243 "properties": {
1244 "allocations": {
1245 "additionalProperties": {
1246 "format": "double",
1247 "type": "number"
1248 },
1249 "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version c an be specified only once, but some versions in the service may not have any tra ffic allocation. Services that have traffic allocated cannot be deleted until ei ther the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based split s and up to three decimal places is supported for cookie-based splits.",
1250 "type": "object"
1251 },
1252 "shardBy": {
1253 "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either ty pe until allocations are changed.",
1021 "enum": [ 1254 "enum": [
1022 "AUTH_FAIL_ACTION_UNSPECIFIED", 1255 "UNSPECIFIED",
1023 "AUTH_FAIL_ACTION_REDIRECT", 1256 "COOKIE",
1024 "AUTH_FAIL_ACTION_UNAUTHORIZED" 1257 "IP",
1258 "RANDOM"
1025 ], 1259 ],
1026 "enumDescriptions": [ 1260 "enumDescriptions": [
1027 "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", 1261 "Diversion method unspecified.",
1028 "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account." , 1262 "Diversion based on a specially named cookie, \"GOOGAPPU ID.\" The cookie must be set by the application itself or no diversion will occu r.",
1029 "Rejects request with a 401 HTTP status code and an erro r message." 1263 "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
1264 "Diversion based on weighted random assignment. An incom ing request is randomly routed to a version in the traffic split, with probabili ty proportional to the version's traffic share."
1030 ], 1265 ],
1031 "type": "string" 1266 "type": "string"
1032 } 1267 }
1033 }, 1268 },
1034 "type": "object" 1269 "type": "object"
1035 }, 1270 },
1036 "EndpointsApiService": { 1271 "OperationMetadataV1Beta": {
1037 "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and conf iguration id of a \"service\" resource in the Service Management API (https://cl oud.google.com/service-management/overview).", 1272 "description": "Metadata for the given google.longrunning.Operation. ",
1038 "id": "EndpointsApiService", 1273 "id": "OperationMetadataV1Beta",
1039 "properties": { 1274 "properties": {
1040 "configId": { 1275 "ephemeralMessage": {
1041 "description": "Endpoints service configuration id as specif ied by the Service Management API. For example \"2016-09-19r1\"", 1276 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
1042 "type": "string" 1277 "type": "string"
1043 }, 1278 },
1044 "name": { 1279 "method": {
1045 "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endp oints.myproject.cloud.goog\"", 1280 "description": "API method that initiated this operation. Ex ample: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
1046 "type": "string" 1281 "type": "string"
1047 } 1282 },
1048 }, 1283 "endTime": {
1049 "type": "object" 1284 "description": "Time that this operation completed.@OutputOn ly",
1050 }, 1285 "format": "google-datetime",
1051 "Operation": { 1286 "type": "string"
1052 "description": "This resource represents a long-running operation th at is the result of a network API call.", 1287 },
1053 "id": "Operation", 1288 "warning": {
1054 "properties": { 1289 "description": "Durable messages that persist on every opera tion poll. @OutputOnly",
1055 "response": { 1290 "items": {
1291 "type": "string"
1292 },
1293 "type": "array"
1294 },
1295 "insertTime": {
1296 "description": "Time that this operation was created.@Output Only",
1297 "format": "google-datetime",
1298 "type": "string"
1299 },
1300 "user": {
1301 "description": "User who requested this operation.@OutputOnl y",
1302 "type": "string"
1303 },
1304 "target": {
1305 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1306 "type": "string"
1307 }
1308 },
1309 "type": "object"
1310 },
1311 "ListServicesResponse": {
1312 "description": "Response message for Services.ListServices.",
1313 "id": "ListServicesResponse",
1314 "properties": {
1315 "nextPageToken": {
1316 "description": "Continuation token for fetching the next pag e of results.",
1317 "type": "string"
1318 },
1319 "services": {
1320 "description": "The services belonging to the requested appl ication.",
1321 "items": {
1322 "$ref": "Service"
1323 },
1324 "type": "array"
1325 }
1326 },
1327 "type": "object"
1328 },
1329 "Deployment": {
1330 "description": "Code and application artifacts used to deploy a vers ion to App Engine.",
1331 "id": "Deployment",
1332 "properties": {
1333 "files": {
1056 "additionalProperties": { 1334 "additionalProperties": {
1057 "description": "Properties of the object. Contains field @type with type URL.", 1335 "$ref": "FileInfo"
1058 "type": "any" 1336 },
1059 }, 1337 "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable u sing the credentials supplied with this call.",
1060 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Cr eate/Update, the response should be the resource. For other methods, the respons e should have the type XxxResponse, where Xxx is the original method name. For e xample, if the original method name is TakeSnapshot(), the inferred response typ e is TakeSnapshotResponse.",
1061 "type": "object" 1338 "type": "object"
1062 }, 1339 },
1063 "name": { 1340 "zip": {
1064 "description": "The server-assigned name, which is only uniq ue within the same service that originally returns it. If you use the default HT TP mapping, the name should have the format of operations/some/unique/name.", 1341 "$ref": "ZipInfo",
1065 "type": "string" 1342 "description": "The zip file for this deployment, if this is a zip deployment."
1066 }, 1343 },
1067 "error": { 1344 "container": {
1068 "$ref": "Status", 1345 "$ref": "ContainerInfo",
1069 "description": "The error result of the operation in case of failure or cancellation." 1346 "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible e nvironment."
1070 }, 1347 }
1071 "metadata": { 1348 },
1072 "additionalProperties": { 1349 "type": "object"
1073 "description": "Properties of the object. Contains field @type with type URL.", 1350 },
1074 "type": "any" 1351 "Resources": {
1075 }, 1352 "description": "Machine resources for a version.",
1076 "description": "Service-specific metadata associated with th e operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", 1353 "id": "Resources",
1077 "type": "object" 1354 "properties": {
1078 }, 1355 "memoryGb": {
1079 "done": { 1356 "description": "Memory (GB) needed.",
1080 "description": "If the value is false, it means the operatio n is still in progress. If true, the operation is completed, and either error or response is available.",
1081 "type": "boolean"
1082 }
1083 },
1084 "type": "object"
1085 },
1086 "ApiConfigHandler": {
1087 "description": "Google Cloud Endpoints (https://cloud.google.com/app engine/docs/python/endpoints/) configuration for API handlers.",
1088 "id": "ApiConfigHandler",
1089 "properties": {
1090 "login": {
1091 "description": "Level of login required to access this resou rce. Defaults to optional.",
1092 "enum": [
1093 "LOGIN_UNSPECIFIED",
1094 "LOGIN_OPTIONAL",
1095 "LOGIN_ADMIN",
1096 "LOGIN_REQUIRED"
1097 ],
1098 "enumDescriptions": [
1099 "Not specified. LOGIN_OPTIONAL is assumed.",
1100 "Does not require that the user is signed in.",
1101 "If the user is not signed in, the auth_fail_action is t aken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an ad ministrator, the handler proceeds.",
1102 "If the user has signed in, the handler proceeds normall y. Otherwise, the auth_fail_action is taken."
1103 ],
1104 "type": "string"
1105 },
1106 "url": {
1107 "description": "URL to serve the endpoint at.",
1108 "type": "string"
1109 },
1110 "securityLevel": {
1111 "description": "Security (HTTPS) enforcement for this URL.",
1112 "enum": [
1113 "SECURE_UNSPECIFIED",
1114 "SECURE_DEFAULT",
1115 "SECURE_NEVER",
1116 "SECURE_OPTIONAL",
1117 "SECURE_ALWAYS"
1118 ],
1119 "enumDescriptions": [
1120 "Not specified.",
1121 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used, and respond accordingly.",
1122 "Requests for a URL that match this handler that use HTT PS are automatically redirected to the HTTP equivalent URL.",
1123 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used and respond accordingly.",
1124 "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Quer y parameters are reserved for the redirect."
1125 ],
1126 "type": "string"
1127 },
1128 "authFailAction": {
1129 "description": "Action to take when users access resources t hat require authentication. Defaults to redirect.",
1130 "enum": [
1131 "AUTH_FAIL_ACTION_UNSPECIFIED",
1132 "AUTH_FAIL_ACTION_REDIRECT",
1133 "AUTH_FAIL_ACTION_UNAUTHORIZED"
1134 ],
1135 "enumDescriptions": [
1136 "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
1137 "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account." ,
1138 "Rejects request with a 401 HTTP status code and an erro r message."
1139 ],
1140 "type": "string"
1141 },
1142 "script": {
1143 "description": "Path to the script from the application root directory.",
1144 "type": "string"
1145 }
1146 },
1147 "type": "object"
1148 },
1149 "StaticFilesHandler": {
1150 "description": "Files served directly to the user for a given URL, s uch as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which U RLs serve them.",
1151 "id": "StaticFilesHandler",
1152 "properties": {
1153 "httpHeaders": {
1154 "additionalProperties": {
1155 "type": "string"
1156 },
1157 "description": "HTTP headers to use for all responses from t hese URLs.",
1158 "type": "object"
1159 },
1160 "applicationReadable": {
1161 "description": "Whether files should also be uploaded as cod e data. By default, files declared in static file handlers are uploaded as stati c data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
1162 "type": "boolean"
1163 },
1164 "uploadPathRegex": {
1165 "description": "Regular expression that matches the file pat hs for all files that should be referenced by this handler.",
1166 "type": "string"
1167 },
1168 "path": {
1169 "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
1170 "type": "string"
1171 },
1172 "mimeType": {
1173 "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each f ile's filename extension.",
1174 "type": "string"
1175 },
1176 "requireMatchingFile": {
1177 "description": "Whether this handler should match the reques t if the file referenced by the handler does not exist.",
1178 "type": "boolean"
1179 },
1180 "expiration": {
1181 "description": "Time a static file served by this handler sh ould be cached by web proxies and browsers.",
1182 "format": "google-duration",
1183 "type": "string"
1184 }
1185 },
1186 "type": "object"
1187 },
1188 "DiskUtilization": {
1189 "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
1190 "id": "DiskUtilization",
1191 "properties": {
1192 "targetWriteBytesPerSecond": {
1193 "description": "Target bytes written per second.",
1194 "format": "int32",
1195 "type": "integer"
1196 },
1197 "targetReadOpsPerSecond": {
1198 "description": "Target ops read per seconds.",
1199 "format": "int32",
1200 "type": "integer"
1201 },
1202 "targetReadBytesPerSecond": {
1203 "description": "Target bytes read per second.",
1204 "format": "int32",
1205 "type": "integer"
1206 },
1207 "targetWriteOpsPerSecond": {
1208 "description": "Target ops written per second.",
1209 "format": "int32",
1210 "type": "integer"
1211 }
1212 },
1213 "type": "object"
1214 },
1215 "BasicScaling": {
1216 "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or dr iven by user activity.",
1217 "id": "BasicScaling",
1218 "properties": {
1219 "idleTimeout": {
1220 "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
1221 "format": "google-duration",
1222 "type": "string"
1223 },
1224 "maxInstances": {
1225 "description": "Maximum number of instances to create for th is version.",
1226 "format": "int32",
1227 "type": "integer"
1228 }
1229 },
1230 "type": "object"
1231 },
1232 "CpuUtilization": {
1233 "description": "Target scaling by CPU usage.",
1234 "id": "CpuUtilization",
1235 "properties": {
1236 "aggregationWindowLength": {
1237 "description": "Period of time over which CPU utilization is calculated.",
1238 "format": "google-duration",
1239 "type": "string"
1240 },
1241 "targetUtilization": {
1242 "description": "Target CPU utilization ratio to maintain whe n scaling. Must be between 0 and 1.",
1243 "format": "double", 1357 "format": "double",
1244 "type": "number" 1358 "type": "number"
1245 } 1359 },
1246 }, 1360 "cpu": {
1247 "type": "object" 1361 "description": "Number of CPU cores needed.",
1248 }, 1362 "format": "double",
1249 "IdentityAwareProxy": { 1363 "type": "number"
1250 "description": "Identity-Aware Proxy", 1364 },
1251 "id": "IdentityAwareProxy", 1365 "volumes": {
1252 "properties": { 1366 "description": "User specified volumes.",
1253 "oauth2ClientSecret": { 1367 "items": {
1254 "description": "OAuth2 client secret to use for the authenti cation flow.For security reasons, this value cannot be retrieved via the API. In stead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha 256 field.@InputOnly", 1368 "$ref": "Volume"
1255 "type": "string" 1369 },
1256 }, 1370 "type": "array"
1257 "oauth2ClientId": { 1371 },
1258 "description": "OAuth2 client ID to use for the authenticati on flow.", 1372 "diskGb": {
1259 "type": "string" 1373 "description": "Disk size (GB) needed.",
1260 }, 1374 "format": "double",
1261 "oauth2ClientSecretSha256": { 1375 "type": "number"
1262 "description": "Hex-encoded SHA-256 hash of the client secre t.@OutputOnly", 1376 }
1263 "type": "string" 1377 },
1264 }, 1378 "type": "object"
1265 "enabled": { 1379 },
1266 "description": "Whether the serving infrastructure will auth enticate and authorize all incoming requests.If true, the oauth2_client_id and o auth2_client_secret fields must be non-empty.", 1380 "Volume": {
1267 "type": "boolean" 1381 "description": "Volumes mounted within the app container. Only appli cable for VM runtimes.",
1268 } 1382 "id": "Volume",
1269 }, 1383 "properties": {
1270 "type": "object" 1384 "volumeType": {
1271 }, 1385 "description": "Underlying volume type, e.g. 'tmpfs'.",
1272 "Status": { 1386 "type": "string"
1273 "description": "The Status type defines a logical error model that i s suitable for different programming environments, including REST APIs and RPC A PIs. It is used by gRPC (https://github.com/grpc). The error model is designed t o be:\nSimple to use and understand for most users\nFlexible enough to meet unex pected needsOverviewThe Status message contains three pieces of data: error code , error message, and error details. The error code should be an enum value of go ogle.rpc.Code, but it may accept additional error codes if needed. The error mes sage should be a developer-facing English message that helps developers understa nd and resolve the error. If a localized user-facing error message is needed, pu t the localized message in the error details or localize it in the client. The o ptional error details may contain arbitrary information about the error. There i s a predefined set of error detail types in the package google.rpc that can be u sed for common error conditions.Language mappingThe Status message is the logica l representation of the error model, but it is not necessarily the actual wire f ormat. When the Status message is exposed in different client libraries and diff erent wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model includ e:\nPartial errors. If a service needs to return partial errors to the client, i t may embed the Status in the normal response to indicate the partial errors.\nW orkflow errors. A typical workflow has multiple steps. Each step may have a Stat us message for error reporting.\nBatch operations. If a client uses batch reques t and batch response, the Status message should be used directly inside batch re sponse, one for each error sub-response.\nAsynchronous operations. If an API cal l embeds asynchronous operation results in its response, the status of those ope rations should be represented directly using the Status message.\nLogging. If so me API errors are stored in logs, the message Status could be used directly afte r any stripping needed for security/privacy reasons.", 1387 },
1274 "id": "Status", 1388 "sizeGb": {
1275 "properties": { 1389 "description": "Volume size in gigabytes.",
1276 "message": { 1390 "format": "double",
1277 "description": "A developer-facing error message, which shou ld be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", 1391 "type": "number"
1278 "type": "string" 1392 },
1279 }, 1393 "name": {
1280 "details": { 1394 "description": "Unique name for the volume.",
1281 "description": "A list of messages that carry the error deta ils. There is a common set of message types for APIs to use.", 1395 "type": "string"
1282 "items": { 1396 }
1283 "additionalProperties": { 1397 },
1284 "description": "Properties of the object. Contains f ield @type with type URL.", 1398 "type": "object"
1285 "type": "any" 1399 },
1286 }, 1400 "ListInstancesResponse": {
1287 "type": "object" 1401 "description": "Response message for Instances.ListInstances.",
1288 }, 1402 "id": "ListInstancesResponse",
1289 "type": "array"
1290 },
1291 "code": {
1292 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1293 "format": "int32",
1294 "type": "integer"
1295 }
1296 },
1297 "type": "object"
1298 },
1299 "ManualScaling": {
1300 "description": "A service with manual scaling runs continuously, all owing you to perform complex initialization and rely on the state of its memory over time.",
1301 "id": "ManualScaling",
1302 "properties": { 1403 "properties": {
1303 "instances": { 1404 "instances": {
1304 "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https: //cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", 1405 "description": "The instances belonging to the requested ver sion.",
1305 "format": "int32", 1406 "items": {
1306 "type": "integer" 1407 "$ref": "Instance"
1307 } 1408 },
1308 }, 1409 "type": "array"
1309 "type": "object" 1410 },
1310 },
1311 "LocationMetadata": {
1312 "description": "Metadata for the given google.cloud.location.Locatio n.",
1313 "id": "LocationMetadata",
1314 "properties": {
1315 "flexibleEnvironmentAvailable": {
1316 "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
1317 "type": "boolean"
1318 },
1319 "standardEnvironmentAvailable": {
1320 "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
1321 "type": "boolean"
1322 }
1323 },
1324 "type": "object"
1325 },
1326 "Service": {
1327 "description": "A Service resource is a logical component of an appl ication that can share state and communicate in a secure fashion with other serv ices. For example, an application that handles customer requests might include s eparate services to handle tasks such as backend data analysis or API requests f rom mobile devices. Each service has a collection of versions that define a spec ific set of code used to implement the functionality of that service.",
1328 "id": "Service",
1329 "properties": {
1330 "name": {
1331 "description": "Full path to the Service resource in the API . Example: apps/myapp/services/default.@OutputOnly",
1332 "type": "string"
1333 },
1334 "split": {
1335 "$ref": "TrafficSplit",
1336 "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
1337 },
1338 "id": {
1339 "description": "Relative name of the service within the appl ication. Example: default.@OutputOnly",
1340 "type": "string"
1341 }
1342 },
1343 "type": "object"
1344 },
1345 "ListOperationsResponse": {
1346 "description": "The response message for Operations.ListOperations." ,
1347 "id": "ListOperationsResponse",
1348 "properties": {
1349 "nextPageToken": { 1411 "nextPageToken": {
1350 "description": "The standard List next-page token.", 1412 "description": "Continuation token for fetching the next pag e of results.",
1351 "type": "string" 1413 "type": "string"
1352 }, 1414 }
1353 "operations": { 1415 },
1354 "description": "A list of operations that matches the specif ied filter in the request.", 1416 "type": "object"
1355 "items": { 1417 },
1356 "$ref": "Operation" 1418 "OperationMetadataV1Alpha": {
1357 },
1358 "type": "array"
1359 }
1360 },
1361 "type": "object"
1362 },
1363 "OperationMetadata": {
1364 "description": "Metadata for the given google.longrunning.Operation. ", 1419 "description": "Metadata for the given google.longrunning.Operation. ",
1365 "id": "OperationMetadata", 1420 "id": "OperationMetadataV1Alpha",
1366 "properties": { 1421 "properties": {
1367 "endTime": {
1368 "description": "Timestamp that this operation completed.@Out putOnly",
1369 "format": "google-datetime",
1370 "type": "string"
1371 },
1372 "operationType": {
1373 "description": "Type of this operation. Deprecated, use meth od field instead. Example: \"create_version\".@OutputOnly",
1374 "type": "string"
1375 },
1376 "insertTime": {
1377 "description": "Timestamp that this operation was created.@O utputOnly",
1378 "format": "google-datetime",
1379 "type": "string"
1380 },
1381 "user": {
1382 "description": "User who requested this operation.@OutputOnl y",
1383 "type": "string"
1384 },
1385 "target": {
1386 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
1387 "type": "string"
1388 },
1389 "method": {
1390 "description": "API method that initiated this operation. Ex ample: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
1391 "type": "string"
1392 }
1393 },
1394 "type": "object"
1395 },
1396 "ErrorHandler": {
1397 "description": "Custom static error page to be served when an error occurs.",
1398 "id": "ErrorHandler",
1399 "properties": {
1400 "mimeType": {
1401 "description": "MIME type of file. Defaults to text/html.",
1402 "type": "string"
1403 },
1404 "errorCode": {
1405 "description": "Error condition this handler applies to.",
1406 "enum": [
1407 "ERROR_CODE_UNSPECIFIED",
1408 "ERROR_CODE_DEFAULT",
1409 "ERROR_CODE_OVER_QUOTA",
1410 "ERROR_CODE_DOS_API_DENIAL",
1411 "ERROR_CODE_TIMEOUT"
1412 ],
1413 "enumDescriptions": [
1414 "Not specified. ERROR_CODE_DEFAULT is assumed.",
1415 "All other error types.",
1416 "Application has exceeded a resource quota.",
1417 "Client blocked by the application's Denial of Service p rotection configuration.",
1418 "Deadline reached before the application responds."
1419 ],
1420 "type": "string"
1421 },
1422 "staticFile": {
1423 "description": "Static file content to be served for this er ror.",
1424 "type": "string"
1425 }
1426 },
1427 "type": "object"
1428 },
1429 "OperationMetadataV1": {
1430 "description": "Metadata for the given google.longrunning.Operation. ",
1431 "id": "OperationMetadataV1",
1432 "properties": {
1433 "endTime": {
1434 "description": "Time that this operation completed.@OutputOn ly",
1435 "format": "google-datetime",
1436 "type": "string"
1437 },
1438 "warning": { 1422 "warning": {
1439 "description": "Durable messages that persist on every opera tion poll. @OutputOnly", 1423 "description": "Durable messages that persist on every opera tion poll. @OutputOnly",
1440 "items": { 1424 "items": {
1441 "type": "string" 1425 "type": "string"
1442 }, 1426 },
1443 "type": "array" 1427 "type": "array"
1444 }, 1428 },
1445 "insertTime": { 1429 "insertTime": {
1446 "description": "Time that this operation was created.@Output Only", 1430 "description": "Time that this operation was created.@Output Only",
1447 "format": "google-datetime", 1431 "format": "google-datetime",
1448 "type": "string" 1432 "type": "string"
1449 }, 1433 },
1434 "target": {
1435 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1436 "type": "string"
1437 },
1450 "user": { 1438 "user": {
1451 "description": "User who requested this operation.@OutputOnl y", 1439 "description": "User who requested this operation.@OutputOnl y",
1452 "type": "string" 1440 "type": "string"
1453 }, 1441 },
1454 "target": {
1455 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1456 "type": "string"
1457 },
1458 "ephemeralMessage": { 1442 "ephemeralMessage": {
1459 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", 1443 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
1460 "type": "string" 1444 "type": "string"
1461 }, 1445 },
1462 "method": { 1446 "method": {
1463 "description": "API method that initiated this operation. Ex ample: google.appengine.v1.Versions.CreateVersion.@OutputOnly", 1447 "description": "API method that initiated this operation. Ex ample: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
1464 "type": "string" 1448 "type": "string"
1465 } 1449 },
1466 }, 1450 "endTime": {
1467 "type": "object" 1451 "description": "Time that this operation completed.@OutputOn ly",
1468 }, 1452 "format": "google-datetime",
1469 "Application": { 1453 "type": "string"
1470 "description": "An Application resource contains the top-level confi guration of an App Engine application. Next tag: 20", 1454 }
1471 "id": "Application", 1455 },
1472 "properties": { 1456 "type": "object"
1473 "locationId": { 1457 },
1474 "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Default s to us-central.Options are:us-central - Central USeurope-west - Western Europeu s-east1 - Eastern US", 1458 "UrlDispatchRule": {
1475 "type": "string" 1459 "description": "Rules to match an HTTP request and dispatch that req uest to a service.",
1476 }, 1460 "id": "UrlDispatchRule",
1477 "servingStatus": { 1461 "properties": {
1478 "description": "Serving status of this application.", 1462 "service": {
1479 "enum": [ 1463 "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
1480 "UNSPECIFIED", 1464 "type": "string"
1481 "SERVING", 1465 },
1482 "USER_DISABLED", 1466 "domain": {
1483 "SYSTEM_DISABLED" 1467 "description": "Domain name to match against. The wildcard \ "*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
1484 ], 1468 "type": "string"
1485 "enumDescriptions": [ 1469 },
1486 "Serving status is unspecified.", 1470 "path": {
1487 "Application is serving.", 1471 "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the leng ths of the domain and path may not exceed 100 characters.",
1488 "Application has been disabled by the user.", 1472 "type": "string"
1489 "Application has been disabled by the system." 1473 }
1490 ], 1474 },
1491 "type": "string" 1475 "type": "object"
1492 }, 1476 },
1493 "defaultHostname": { 1477 "ListVersionsResponse": {
1494 "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly", 1478 "description": "Response message for Versions.ListVersions.",
1495 "type": "string" 1479 "id": "ListVersionsResponse",
1496 }, 1480 "properties": {
1497 "authDomain": { 1481 "versions": {
1498 "description": "Google Apps authentication domain that contr ols which users can access this application.Defaults to open access for any Goog le Account.", 1482 "description": "The versions belonging to the requested serv ice.",
1499 "type": "string"
1500 },
1501 "iap": {
1502 "$ref": "IdentityAwareProxy"
1503 },
1504 "codeBucket": {
1505 "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated w ith the application and can be used by the gcloud deployment commands.@OutputOnl y",
1506 "type": "string"
1507 },
1508 "defaultBucket": {
1509 "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
1510 "type": "string"
1511 },
1512 "dispatchRules": {
1513 "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order -dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
1514 "items": { 1483 "items": {
1515 "$ref": "UrlDispatchRule" 1484 "$ref": "Version"
1516 }, 1485 },
1517 "type": "array" 1486 "type": "array"
1518 }, 1487 },
1519 "gcrDomain": { 1488 "nextPageToken": {
1520 "description": "The Google Container Registry domain used fo r storing managed build docker images for this application.", 1489 "description": "Continuation token for fetching the next pag e of results.",
1521 "type": "string" 1490 "type": "string"
1522 }, 1491 }
1492 },
1493 "type": "object"
1494 },
1495 "ApiEndpointHandler": {
1496 "description": "Uses Google Cloud Endpoints to handle requests.",
1497 "id": "ApiEndpointHandler",
1498 "properties": {
1499 "scriptPath": {
1500 "description": "Path to the script from the application root directory.",
1501 "type": "string"
1502 }
1503 },
1504 "type": "object"
1505 },
1506 "ZipInfo": {
1507 "description": "The zip file information for a zip deployment.",
1508 "id": "ZipInfo",
1509 "properties": {
1510 "sourceUrl": {
1511 "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googl eapis.com/<bucket>/<object>'.",
1512 "type": "string"
1513 },
1514 "filesCount": {
1515 "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be s low.",
1516 "format": "int32",
1517 "type": "integer"
1518 }
1519 },
1520 "type": "object"
1521 },
1522 "AutomaticScaling": {
1523 "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
1524 "id": "AutomaticScaling",
1525 "properties": {
1526 "cpuUtilization": {
1527 "$ref": "CpuUtilization",
1528 "description": "Target scaling by CPU usage."
1529 },
1530 "diskUtilization": {
1531 "$ref": "DiskUtilization",
1532 "description": "Target scaling by disk usage."
1533 },
1534 "minPendingLatency": {
1535 "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
1536 "format": "google-duration",
1537 "type": "string"
1538 },
1539 "maxIdleInstances": {
1540 "description": "Maximum number of idle instances that should be maintained for this version.",
1541 "format": "int32",
1542 "type": "integer"
1543 },
1544 "requestUtilization": {
1545 "$ref": "RequestUtilization",
1546 "description": "Target scaling by request utilization."
1547 },
1548 "minIdleInstances": {
1549 "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a se rvice.",
1550 "format": "int32",
1551 "type": "integer"
1552 },
1553 "maxTotalInstances": {
1554 "description": "Maximum number of instances that should be s tarted to handle requests.",
1555 "format": "int32",
1556 "type": "integer"
1557 },
1558 "minTotalInstances": {
1559 "description": "Minimum number of instances that should be m aintained for this version.",
1560 "format": "int32",
1561 "type": "integer"
1562 },
1563 "networkUtilization": {
1564 "$ref": "NetworkUtilization",
1565 "description": "Target scaling by network usage."
1566 },
1567 "maxConcurrentRequests": {
1568 "description": "Number of concurrent requests an automatic s caling instance can accept before the scheduler spawns a new instance.Defaults t o a runtime-specific value.",
1569 "format": "int32",
1570 "type": "integer"
1571 },
1572 "coolDownPeriod": {
1573 "description": "Amount of time that the Autoscaler (https:// cloud.google.com/compute/docs/autoscaler/) should wait between changes to the nu mber of virtual machines. Only applicable for VM runtimes.",
1574 "format": "google-duration",
1575 "type": "string"
1576 },
1577 "maxPendingLatency": {
1578 "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
1579 "format": "google-duration",
1580 "type": "string"
1581 }
1582 },
1583 "type": "object"
1584 },
1585 "Library": {
1586 "description": "Third-party Python runtime library that is required by the application.",
1587 "id": "Library",
1588 "properties": {
1523 "name": { 1589 "name": {
1524 "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", 1590 "description": "Name of the library. Example: \"django\".",
1525 "type": "string" 1591 "type": "string"
1526 }, 1592 },
1527 "defaultCookieExpiration": { 1593 "version": {
1528 "description": "Cookie expiration policy for this applicatio n.", 1594 "description": "Version of the library to select, or \"lates t\".",
1529 "format": "google-duration", 1595 "type": "string"
1530 "type": "string" 1596 }
1531 }, 1597 },
1532 "id": { 1598 "type": "object"
1533 "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", 1599 },
1534 "type": "string" 1600 "ListLocationsResponse": {
1535 } 1601 "description": "The response message for Locations.ListLocations.",
1536 }, 1602 "id": "ListLocationsResponse",
1537 "type": "object" 1603 "properties": {
1538 }, 1604 "nextPageToken": {
1539 "Network": { 1605 "description": "The standard List next-page token.",
1540 "description": "Extra network settings. Only applicable for VM runti mes.", 1606 "type": "string"
1541 "id": "Network", 1607 },
1542 "properties": { 1608 "locations": {
1543 "subnetworkName": { 1609 "description": "A list of locations that matches the specifi ed filter in the request.",
1544 "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP addr ess is created from the IPCidrRange of the subnetwork that exists in that zone f or that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP addr ess is created from the IPCidrRange of the subnetwork.If specified, the subnetwo rk must exist in the same region as the Flex app.",
1545 "type": "string"
1546 },
1547 "instanceTag": {
1548 "description": "Tag to apply to the VM instance during creat ion.",
1549 "type": "string"
1550 },
1551 "forwardedPorts": {
1552 "description": "List of ports, or port pairs, to forward fro m the virtual machine to the application container.",
1553 "items": { 1610 "items": {
1554 "type": "string" 1611 "$ref": "Location"
1555 }, 1612 },
1556 "type": "array" 1613 "type": "array"
1614 }
1615 },
1616 "type": "object"
1617 },
1618 "ContainerInfo": {
1619 "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instanc es running in the App Engine flexible environment.",
1620 "id": "ContainerInfo",
1621 "properties": {
1622 "image": {
1623 "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\" ",
1624 "type": "string"
1625 }
1626 },
1627 "type": "object"
1628 },
1629 "RequestUtilization": {
1630 "description": "Target scaling by request utilization. Only applicab le for VM runtimes.",
1631 "id": "RequestUtilization",
1632 "properties": {
1633 "targetRequestCountPerSecond": {
1634 "description": "Target requests per second.",
1635 "format": "int32",
1636 "type": "integer"
1637 },
1638 "targetConcurrentRequests": {
1639 "description": "Target number of concurrent requests.",
1640 "format": "int32",
1641 "type": "integer"
1642 }
1643 },
1644 "type": "object"
1645 },
1646 "EndpointsApiService": {
1647 "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and conf iguration id of a \"service\" resource in the Service Management API (https://cl oud.google.com/service-management/overview).",
1648 "id": "EndpointsApiService",
1649 "properties": {
1650 "configId": {
1651 "description": "Endpoints service configuration id as specif ied by the Service Management API. For example \"2016-09-19r1\"",
1652 "type": "string"
1557 }, 1653 },
1558 "name": { 1654 "name": {
1559 "description": "Google Cloud Platform network where the virt ual machines are created. Specify the short name, not the resource path.Defaults to default.", 1655 "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endp oints.myproject.cloud.goog\"",
1560 "type": "string" 1656 "type": "string"
1561 } 1657 }
1562 }, 1658 },
1563 "type": "object" 1659 "type": "object"
1564 }, 1660 },
1565 "Instance": { 1661 "UrlMap": {
1566 "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", 1662 "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
1567 "id": "Instance", 1663 "id": "UrlMap",
1568 "properties": { 1664 "properties": {
1569 "vmDebugEnabled": { 1665 "securityLevel": {
1570 "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly", 1666 "description": "Security (HTTPS) enforcement for this URL.",
1571 "type": "boolean" 1667 "enum": [
1572 }, 1668 "SECURE_UNSPECIFIED",
1573 "requests": { 1669 "SECURE_DEFAULT",
1574 "description": "Number of requests since this instance was s tarted.@OutputOnly", 1670 "SECURE_NEVER",
1575 "format": "int32", 1671 "SECURE_OPTIONAL",
1576 "type": "integer" 1672 "SECURE_ALWAYS"
1577 }, 1673 ],
1578 "appEngineRelease": { 1674 "enumDescriptions": [
1579 "description": "App Engine release this instance is running on.@OutputOnly", 1675 "Not specified.",
1580 "type": "string" 1676 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used, and respond accordingly.",
1581 }, 1677 "Requests for a URL that match this handler that use HTT PS are automatically redirected to the HTTP equivalent URL.",
1582 "vmName": { 1678 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used and respond accordingly.",
1583 "description": "Name of the virtual machine where this insta nce lives. Only applicable for instances in App Engine flexible environment.@Out putOnly", 1679 "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Quer y parameters are reserved for the redirect."
1584 "type": "string" 1680 ],
1585 }, 1681 "type": "string"
1586 "qps": { 1682 },
1587 "description": "Average queries per second (QPS) over the la st minute.@OutputOnly", 1683 "authFailAction": {
1588 "format": "float", 1684 "description": "Action to take when users access resources t hat require authentication. Defaults to redirect.",
1589 "type": "number" 1685 "enum": [
1590 }, 1686 "AUTH_FAIL_ACTION_UNSPECIFIED",
1591 "vmId": { 1687 "AUTH_FAIL_ACTION_REDIRECT",
1592 "description": "Virtual machine ID of this instance. Only ap plicable for instances in App Engine flexible environment.@OutputOnly", 1688 "AUTH_FAIL_ACTION_UNAUTHORIZED"
1593 "type": "string" 1689 ],
1594 }, 1690 "enumDescriptions": [
1595 "vmZoneName": { 1691 "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
1596 "description": "Zone where the virtual machine is located. O nly applicable for instances in App Engine flexible environment.@OutputOnly", 1692 "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account." ,
1597 "type": "string" 1693 "Rejects request with a 401 HTTP status code and an erro r message."
1694 ],
1695 "type": "string"
1696 },
1697 "script": {
1698 "$ref": "ScriptHandler",
1699 "description": "Executes a script to handle the request that matches this URL pattern."
1700 },
1701 "urlRegex": {
1702 "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain gr oupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
1703 "type": "string"
1704 },
1705 "login": {
1706 "description": "Level of login required to access this resou rce.",
1707 "enum": [
1708 "LOGIN_UNSPECIFIED",
1709 "LOGIN_OPTIONAL",
1710 "LOGIN_ADMIN",
1711 "LOGIN_REQUIRED"
1712 ],
1713 "enumDescriptions": [
1714 "Not specified. LOGIN_OPTIONAL is assumed.",
1715 "Does not require that the user is signed in.",
1716 "If the user is not signed in, the auth_fail_action is t aken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an ad ministrator, the handler proceeds.",
1717 "If the user has signed in, the handler proceeds normall y. Otherwise, the auth_fail_action is taken."
1718 ],
1719 "type": "string"
1720 },
1721 "apiEndpoint": {
1722 "$ref": "ApiEndpointHandler",
1723 "description": "Uses API Endpoints to handle requests."
1724 },
1725 "staticFiles": {
1726 "$ref": "StaticFilesHandler",
1727 "description": "Returns the contents of a file, such as an i mage, as the response."
1728 },
1729 "redirectHttpResponseCode": {
1730 "description": "30x code to use when performing redirects fo r the secure field. Defaults to 302.",
1731 "enum": [
1732 "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
1733 "REDIRECT_HTTP_RESPONSE_CODE_301",
1734 "REDIRECT_HTTP_RESPONSE_CODE_302",
1735 "REDIRECT_HTTP_RESPONSE_CODE_303",
1736 "REDIRECT_HTTP_RESPONSE_CODE_307"
1737 ],
1738 "enumDescriptions": [
1739 "Not specified. 302 is assumed.",
1740 "301 Moved Permanently code.",
1741 "302 Moved Temporarily code.",
1742 "303 See Other code.",
1743 "307 Temporary Redirect code."
1744 ],
1745 "type": "string"
1746 }
1747 },
1748 "type": "object"
1749 },
1750 "ApiConfigHandler": {
1751 "description": "Google Cloud Endpoints (https://cloud.google.com/app engine/docs/python/endpoints/) configuration for API handlers.",
1752 "id": "ApiConfigHandler",
1753 "properties": {
1754 "securityLevel": {
1755 "description": "Security (HTTPS) enforcement for this URL.",
1756 "enum": [
1757 "SECURE_UNSPECIFIED",
1758 "SECURE_DEFAULT",
1759 "SECURE_NEVER",
1760 "SECURE_OPTIONAL",
1761 "SECURE_ALWAYS"
1762 ],
1763 "enumDescriptions": [
1764 "Not specified.",
1765 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used, and respond accordingly.",
1766 "Requests for a URL that match this handler that use HTT PS are automatically redirected to the HTTP equivalent URL.",
1767 "Both HTTP and HTTPS requests with URLs that match the h andler succeed without redirects. The application can examine the request to det ermine which protocol was used and respond accordingly.",
1768 "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Quer y parameters are reserved for the redirect."
1769 ],
1770 "type": "string"
1771 },
1772 "authFailAction": {
1773 "description": "Action to take when users access resources t hat require authentication. Defaults to redirect.",
1774 "enum": [
1775 "AUTH_FAIL_ACTION_UNSPECIFIED",
1776 "AUTH_FAIL_ACTION_REDIRECT",
1777 "AUTH_FAIL_ACTION_UNAUTHORIZED"
1778 ],
1779 "enumDescriptions": [
1780 "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
1781 "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account." ,
1782 "Rejects request with a 401 HTTP status code and an erro r message."
1783 ],
1784 "type": "string"
1785 },
1786 "script": {
1787 "description": "Path to the script from the application root directory.",
1788 "type": "string"
1789 },
1790 "login": {
1791 "description": "Level of login required to access this resou rce. Defaults to optional.",
1792 "enum": [
1793 "LOGIN_UNSPECIFIED",
1794 "LOGIN_OPTIONAL",
1795 "LOGIN_ADMIN",
1796 "LOGIN_REQUIRED"
1797 ],
1798 "enumDescriptions": [
1799 "Not specified. LOGIN_OPTIONAL is assumed.",
1800 "Does not require that the user is signed in.",
1801 "If the user is not signed in, the auth_fail_action is t aken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an ad ministrator, the handler proceeds.",
1802 "If the user has signed in, the handler proceeds normall y. Otherwise, the auth_fail_action is taken."
1803 ],
1804 "type": "string"
1805 },
1806 "url": {
1807 "description": "URL to serve the endpoint at.",
1808 "type": "string"
1809 }
1810 },
1811 "type": "object"
1812 },
1813 "Operation": {
1814 "description": "This resource represents a long-running operation th at is the result of a network API call.",
1815 "id": "Operation",
1816 "properties": {
1817 "response": {
1818 "additionalProperties": {
1819 "description": "Properties of the object. Contains field @type with type URL.",
1820 "type": "any"
1821 },
1822 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Cr eate/Update, the response should be the resource. For other methods, the respons e should have the type XxxResponse, where Xxx is the original method name. For e xample, if the original method name is TakeSnapshot(), the inferred response typ e is TakeSnapshotResponse.",
1823 "type": "object"
1598 }, 1824 },
1599 "name": { 1825 "name": {
1600 "description": "Full path to the Instance resource in the AP I. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@Output Only", 1826 "description": "The server-assigned name, which is only uniq ue within the same service that originally returns it. If you use the default HT TP mapping, the name should have the format of operations/some/unique/name.",
1601 "type": "string" 1827 "type": "string"
1602 }, 1828 },
1603 "averageLatency": { 1829 "error": {
1604 "description": "Average latency (ms) over the last minute.@O utputOnly", 1830 "$ref": "Status",
1605 "format": "int32", 1831 "description": "The error result of the operation in case of failure or cancellation."
1606 "type": "integer"
1607 },
1608 "id": {
1609 "description": "Relative name of the instance within the ver sion. Example: instance-1.@OutputOnly",
1610 "type": "string"
1611 },
1612 "vmIp": {
1613 "description": "The IP address of this instance. Only applic able for instances in App Engine flexible environment.@OutputOnly",
1614 "type": "string"
1615 },
1616 "memoryUsage": {
1617 "description": "Total memory in use (bytes).@OutputOnly",
1618 "format": "int64",
1619 "type": "string"
1620 },
1621 "availability": {
1622 "description": "Availability of the instance.@OutputOnly",
1623 "enum": [
1624 "UNSPECIFIED",
1625 "RESIDENT",
1626 "DYNAMIC"
1627 ],
1628 "enumDescriptions": [
1629 "",
1630 "",
1631 ""
1632 ],
1633 "type": "string"
1634 },
1635 "vmStatus": {
1636 "description": "Status of the virtual machine where this ins tance lives. Only applicable for instances in App Engine flexible environment.@O utputOnly",
1637 "type": "string"
1638 },
1639 "errors": {
1640 "description": "Number of errors since this instance was sta rted.@OutputOnly",
1641 "format": "int32",
1642 "type": "integer"
1643 },
1644 "startTime": {
1645 "description": "Time that this instance was started.@OutputO nly",
1646 "format": "google-datetime",
1647 "type": "string"
1648 }
1649 },
1650 "type": "object"
1651 },
1652 "LivenessCheck": {
1653 "description": "Health checking configuration for VM instances. Unhe althy instances are killed and replaced with new instances.",
1654 "id": "LivenessCheck",
1655 "properties": {
1656 "checkInterval": {
1657 "description": "Interval between health checks.",
1658 "format": "google-duration",
1659 "type": "string"
1660 },
1661 "failureThreshold": {
1662 "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
1663 "format": "uint32",
1664 "type": "integer"
1665 },
1666 "timeout": {
1667 "description": "Time before the check is considered failed." ,
1668 "format": "google-duration",
1669 "type": "string"
1670 },
1671 "initialDelay": {
1672 "description": "The initial delay before starting to execute the checks.",
1673 "format": "google-duration",
1674 "type": "string"
1675 },
1676 "path": {
1677 "description": "The request path.",
1678 "type": "string"
1679 },
1680 "successThreshold": {
1681 "description": "Number of consecutive successful checks requ ired before considering the VM healthy.",
1682 "format": "uint32",
1683 "type": "integer"
1684 },
1685 "host": {
1686 "description": "Host header to send when performing a HTTP L iveness check. Example: \"myapp.appspot.com\"",
1687 "type": "string"
1688 }
1689 },
1690 "type": "object"
1691 },
1692 "Location": {
1693 "description": "A resource that represents Google Cloud Platform loc ation.",
1694 "id": "Location",
1695 "properties": {
1696 "labels": {
1697 "additionalProperties": {
1698 "type": "string"
1699 },
1700 "description": "Cross-service attributes for the location. F or example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
1701 "type": "object"
1702 },
1703 "name": {
1704 "description": "Resource name for the location, which may va ry between implementations. For example: \"projects/example-project/locations/us -east1\"",
1705 "type": "string"
1706 },
1707 "locationId": {
1708 "description": "The canonical id for this location. For exam ple: \"us-east1\".",
1709 "type": "string"
1710 }, 1832 },
1711 "metadata": { 1833 "metadata": {
1712 "additionalProperties": { 1834 "additionalProperties": {
1713 "description": "Properties of the object. Contains field @type with type URL.", 1835 "description": "Properties of the object. Contains field @type with type URL.",
1714 "type": "any" 1836 "type": "any"
1715 }, 1837 },
1716 "description": "Service-specific metadata. For example the a vailable capacity at the given location.", 1838 "description": "Service-specific metadata associated with th e operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
1717 "type": "object" 1839 "type": "object"
1718 } 1840 },
1719 }, 1841 "done": {
1720 "type": "object" 1842 "description": "If the value is false, it means the operatio n is still in progress. If true, the operation is completed, and either error or response is available.",
1721 }, 1843 "type": "boolean"
1722 "NetworkUtilization": { 1844 }
1723 "description": "Target scaling by network usage. Only applicable for VM runtimes.", 1845 },
1724 "id": "NetworkUtilization", 1846 "type": "object"
1725 "properties": { 1847 },
1726 "targetReceivedPacketsPerSecond": { 1848 "StaticFilesHandler": {
1727 "description": "Target packets received per second.", 1849 "description": "Files served directly to the user for a given URL, s uch as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which U RLs serve them.",
1728 "format": "int32", 1850 "id": "StaticFilesHandler",
1729 "type": "integer" 1851 "properties": {
1730 }, 1852 "expiration": {
1731 "targetSentBytesPerSecond": { 1853 "description": "Time a static file served by this handler sh ould be cached by web proxies and browsers.",
1732 "description": "Target bytes sent per second.",
1733 "format": "int32",
1734 "type": "integer"
1735 },
1736 "targetReceivedBytesPerSecond": {
1737 "description": "Target bytes received per second.",
1738 "format": "int32",
1739 "type": "integer"
1740 },
1741 "targetSentPacketsPerSecond": {
1742 "description": "Target packets sent per second.",
1743 "format": "int32",
1744 "type": "integer"
1745 }
1746 },
1747 "type": "object"
1748 },
1749 "HealthCheck": {
1750 "description": "Health checking configuration for VM instances. Unhe althy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
1751 "id": "HealthCheck",
1752 "properties": {
1753 "timeout": {
1754 "description": "Time before the health check is considered f ailed.",
1755 "format": "google-duration", 1854 "format": "google-duration",
1756 "type": "string" 1855 "type": "string"
1757 }, 1856 },
1758 "unhealthyThreshold": { 1857 "httpHeaders": {
1759 "description": "Number of consecutive failed health checks r equired before removing traffic.", 1858 "additionalProperties": {
1760 "format": "uint32", 1859 "type": "string"
1761 "type": "integer" 1860 },
1762 }, 1861 "description": "HTTP headers to use for all responses from t hese URLs.",
1763 "disableHealthCheck": { 1862 "type": "object"
1764 "description": "Whether to explicitly disable health checks for this instance.", 1863 },
1864 "applicationReadable": {
1865 "description": "Whether files should also be uploaded as cod e data. By default, files declared in static file handlers are uploaded as stati c data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
1765 "type": "boolean" 1866 "type": "boolean"
1766 }, 1867 },
1767 "host": { 1868 "uploadPathRegex": {
1768 "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"", 1869 "description": "Regular expression that matches the file pat hs for all files that should be referenced by this handler.",
1769 "type": "string" 1870 "type": "string"
1770 }, 1871 },
1771 "healthyThreshold": { 1872 "path": {
1772 "description": "Number of consecutive successful health chec ks required before receiving traffic.", 1873 "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
1773 "format": "uint32", 1874 "type": "string"
1774 "type": "integer" 1875 },
1775 }, 1876 "mimeType": {
1776 "restartThreshold": { 1877 "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each f ile's filename extension.",
1777 "description": "Number of consecutive failed health checks r equired before an instance is restarted.", 1878 "type": "string"
1778 "format": "uint32", 1879 },
1779 "type": "integer" 1880 "requireMatchingFile": {
1780 }, 1881 "description": "Whether this handler should match the reques t if the file referenced by the handler does not exist.",
1781 "checkInterval": { 1882 "type": "boolean"
1782 "description": "Interval between health checks.", 1883 }
1884 },
1885 "type": "object"
1886 },
1887 "BasicScaling": {
1888 "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or dr iven by user activity.",
1889 "id": "BasicScaling",
1890 "properties": {
1891 "maxInstances": {
1892 "description": "Maximum number of instances to create for th is version.",
1893 "format": "int32",
1894 "type": "integer"
1895 },
1896 "idleTimeout": {
1897 "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
1783 "format": "google-duration", 1898 "format": "google-duration",
1784 "type": "string" 1899 "type": "string"
1785 } 1900 }
1786 }, 1901 },
1787 "type": "object" 1902 "type": "object"
1788 }, 1903 },
1789 "ReadinessCheck": { 1904 "DiskUtilization": {
1790 "description": "Readiness checking configuration for VM instances. U nhealthy instances are removed from traffic rotation.", 1905 "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
1791 "id": "ReadinessCheck", 1906 "id": "DiskUtilization",
1792 "properties": { 1907 "properties": {
1793 "checkInterval": { 1908 "targetReadOpsPerSecond": {
1794 "description": "Interval between health checks.", 1909 "description": "Target ops read per seconds.",
1910 "format": "int32",
1911 "type": "integer"
1912 },
1913 "targetReadBytesPerSecond": {
1914 "description": "Target bytes read per second.",
1915 "format": "int32",
1916 "type": "integer"
1917 },
1918 "targetWriteOpsPerSecond": {
1919 "description": "Target ops written per second.",
1920 "format": "int32",
1921 "type": "integer"
1922 },
1923 "targetWriteBytesPerSecond": {
1924 "description": "Target bytes written per second.",
1925 "format": "int32",
1926 "type": "integer"
1927 }
1928 },
1929 "type": "object"
1930 },
1931 "CpuUtilization": {
1932 "description": "Target scaling by CPU usage.",
1933 "id": "CpuUtilization",
1934 "properties": {
1935 "aggregationWindowLength": {
1936 "description": "Period of time over which CPU utilization is calculated.",
1795 "format": "google-duration", 1937 "format": "google-duration",
1796 "type": "string" 1938 "type": "string"
1797 }, 1939 },
1798 "timeout": { 1940 "targetUtilization": {
1799 "description": "Time before the check is considered failed." , 1941 "description": "Target CPU utilization ratio to maintain whe n scaling. Must be between 0 and 1.",
1800 "format": "google-duration", 1942 "format": "double",
1801 "type": "string" 1943 "type": "number"
1802 }, 1944 }
1803 "failureThreshold": { 1945 },
1804 "description": "Number of consecutive failed checks required before removing traffic.", 1946 "type": "object"
1805 "format": "uint32", 1947 },
1806 "type": "integer" 1948 "Status": {
1807 }, 1949 "description": "The Status type defines a logical error model that i s suitable for different programming environments, including REST APIs and RPC A PIs. It is used by gRPC (https://github.com/grpc). The error model is designed t o be:\nSimple to use and understand for most users\nFlexible enough to meet unex pected needsOverviewThe Status message contains three pieces of data: error code , error message, and error details. The error code should be an enum value of go ogle.rpc.Code, but it may accept additional error codes if needed. The error mes sage should be a developer-facing English message that helps developers understa nd and resolve the error. If a localized user-facing error message is needed, pu t the localized message in the error details or localize it in the client. The o ptional error details may contain arbitrary information about the error. There i s a predefined set of error detail types in the package google.rpc that can be u sed for common error conditions.Language mappingThe Status message is the logica l representation of the error model, but it is not necessarily the actual wire f ormat. When the Status message is exposed in different client libraries and diff erent wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model includ e:\nPartial errors. If a service needs to return partial errors to the client, i t may embed the Status in the normal response to indicate the partial errors.\nW orkflow errors. A typical workflow has multiple steps. Each step may have a Stat us message for error reporting.\nBatch operations. If a client uses batch reques t and batch response, the Status message should be used directly inside batch re sponse, one for each error sub-response.\nAsynchronous operations. If an API cal l embeds asynchronous operation results in its response, the status of those ope rations should be represented directly using the Status message.\nLogging. If so me API errors are stored in logs, the message Status could be used directly afte r any stripping needed for security/privacy reasons.",
1808 "appStartTimeout": { 1950 "id": "Status",
1809 "description": "A maximum time limit on application initiali zation, measured from moment the application successfully replies to a healthche ck until it is ready to serve traffic.", 1951 "properties": {
1810 "format": "google-duration", 1952 "details": {
1811 "type": "string" 1953 "description": "A list of messages that carry the error deta ils. There is a common set of message types for APIs to use.",
1812 }, 1954 "items": {
1813 "path": { 1955 "additionalProperties": {
1814 "description": "The request path.", 1956 "description": "Properties of the object. Contains f ield @type with type URL.",
1815 "type": "string" 1957 "type": "any"
1816 }, 1958 },
1817 "host": { 1959 "type": "object"
1818 "description": "Host header to send when performing a HTTP R eadiness check. Example: \"myapp.appspot.com\"", 1960 },
1819 "type": "string" 1961 "type": "array"
1820 }, 1962 },
1821 "successThreshold": { 1963 "code": {
1822 "description": "Number of consecutive successful checks requ ired before receiving traffic.", 1964 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1823 "format": "uint32", 1965 "format": "int32",
1824 "type": "integer" 1966 "type": "integer"
1825 } 1967 },
1826 }, 1968 "message": {
1827 "type": "object" 1969 "description": "A developer-facing error message, which shou ld be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
1828 }, 1970 "type": "string"
1829 "DebugInstanceRequest": { 1971 }
1830 "description": "Request message for Instances.DebugInstance.", 1972 },
1831 "id": "DebugInstanceRequest", 1973 "type": "object"
1832 "properties": { 1974 },
1833 "sshKey": { 1975 "IdentityAwareProxy": {
1834 "description": "Public SSH key to add to the instance. Examp les:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/ docs/instances/adding-removing-ssh-keys).", 1976 "description": "Identity-Aware Proxy",
1835 "type": "string" 1977 "id": "IdentityAwareProxy",
1836 } 1978 "properties": {
1837 }, 1979 "oauth2ClientSecret": {
1838 "type": "object" 1980 "description": "OAuth2 client secret to use for the authenti cation flow.For security reasons, this value cannot be retrieved via the API. In stead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha 256 field.@InputOnly",
1839 }, 1981 "type": "string"
1840 "OperationMetadataV1Beta5": { 1982 },
1983 "oauth2ClientId": {
1984 "description": "OAuth2 client ID to use for the authenticati on flow.",
1985 "type": "string"
1986 },
1987 "oauth2ClientSecretSha256": {
1988 "description": "Hex-encoded SHA-256 hash of the client secre t.@OutputOnly",
1989 "type": "string"
1990 },
1991 "enabled": {
1992 "description": "Whether the serving infrastructure will auth enticate and authorize all incoming requests.If true, the oauth2_client_id and o auth2_client_secret fields must be non-empty.",
1993 "type": "boolean"
1994 }
1995 },
1996 "type": "object"
1997 },
1998 "ManualScaling": {
1999 "description": "A service with manual scaling runs continuously, all owing you to perform complex initialization and rely on the state of its memory over time.",
2000 "id": "ManualScaling",
2001 "properties": {
2002 "instances": {
2003 "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https: //cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
2004 "format": "int32",
2005 "type": "integer"
2006 }
2007 },
2008 "type": "object"
2009 },
2010 "LocationMetadata": {
2011 "description": "Metadata for the given google.cloud.location.Locatio n.",
2012 "id": "LocationMetadata",
2013 "properties": {
2014 "standardEnvironmentAvailable": {
2015 "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
2016 "type": "boolean"
2017 },
2018 "flexibleEnvironmentAvailable": {
2019 "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
2020 "type": "boolean"
2021 }
2022 },
2023 "type": "object"
2024 },
2025 "Service": {
2026 "description": "A Service resource is a logical component of an appl ication that can share state and communicate in a secure fashion with other serv ices. For example, an application that handles customer requests might include s eparate services to handle tasks such as backend data analysis or API requests f rom mobile devices. Each service has a collection of versions that define a spec ific set of code used to implement the functionality of that service.",
2027 "id": "Service",
2028 "properties": {
2029 "id": {
2030 "description": "Relative name of the service within the appl ication. Example: default.@OutputOnly",
2031 "type": "string"
2032 },
2033 "name": {
2034 "description": "Full path to the Service resource in the API . Example: apps/myapp/services/default.@OutputOnly",
2035 "type": "string"
2036 },
2037 "split": {
2038 "$ref": "TrafficSplit",
2039 "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
2040 }
2041 },
2042 "type": "object"
2043 },
2044 "ListOperationsResponse": {
2045 "description": "The response message for Operations.ListOperations." ,
2046 "id": "ListOperationsResponse",
2047 "properties": {
2048 "nextPageToken": {
2049 "description": "The standard List next-page token.",
2050 "type": "string"
2051 },
2052 "operations": {
2053 "description": "A list of operations that matches the specif ied filter in the request.",
2054 "items": {
2055 "$ref": "Operation"
2056 },
2057 "type": "array"
2058 }
2059 },
2060 "type": "object"
2061 },
2062 "OperationMetadata": {
1841 "description": "Metadata for the given google.longrunning.Operation. ", 2063 "description": "Metadata for the given google.longrunning.Operation. ",
1842 "id": "OperationMetadataV1Beta5", 2064 "id": "OperationMetadata",
1843 "properties": { 2065 "properties": {
1844 "method": { 2066 "endTime": {
1845 "description": "API method name that initiated this operatio n. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly", 2067 "description": "Timestamp that this operation completed.@Out putOnly",
2068 "format": "google-datetime",
2069 "type": "string"
2070 },
2071 "operationType": {
2072 "description": "Type of this operation. Deprecated, use meth od field instead. Example: \"create_version\".@OutputOnly",
1846 "type": "string" 2073 "type": "string"
1847 }, 2074 },
1848 "insertTime": { 2075 "insertTime": {
1849 "description": "Timestamp that this operation was created.@O utputOnly", 2076 "description": "Timestamp that this operation was created.@O utputOnly",
1850 "format": "google-datetime", 2077 "format": "google-datetime",
1851 "type": "string" 2078 "type": "string"
1852 }, 2079 },
1853 "endTime": {
1854 "description": "Timestamp that this operation completed.@Out putOnly",
1855 "format": "google-datetime",
1856 "type": "string"
1857 },
1858 "target": {
1859 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1860 "type": "string"
1861 },
1862 "user": { 2080 "user": {
1863 "description": "User who requested this operation.@OutputOnl y", 2081 "description": "User who requested this operation.@OutputOnl y",
1864 "type": "string" 2082 "type": "string"
1865 } 2083 },
1866 }, 2084 "target": {
1867 "type": "object" 2085 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
1868 }, 2086 "type": "string"
1869 "Version": { 2087 },
1870 "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", 2088 "method": {
1871 "id": "Version", 2089 "description": "API method that initiated this operation. Ex ample: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
1872 "properties": { 2090 "type": "string"
1873 "basicScaling": { 2091 }
1874 "$ref": "BasicScaling", 2092 },
1875 "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned do wn when the app becomes idle. Basic scaling is ideal for work that is intermitte nt or driven by user activity." 2093 "type": "object"
1876 }, 2094 },
1877 "runtime": { 2095 "ErrorHandler": {
1878 "description": "Desired runtime. Example: python27.", 2096 "description": "Custom static error page to be served when an error occurs.",
1879 "type": "string" 2097 "id": "ErrorHandler",
1880 }, 2098 "properties": {
1881 "createdBy": { 2099 "mimeType": {
1882 "description": "Email address of the user who created this v ersion.@OutputOnly", 2100 "description": "MIME type of file. Defaults to text/html.",
1883 "type": "string" 2101 "type": "string"
1884 }, 2102 },
1885 "id": { 2103 "errorCode": {
1886 "description": "Relative name of the version within the serv ice. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \ "ah-\".", 2104 "description": "Error condition this handler applies to.",
1887 "type": "string"
1888 },
1889 "envVariables": {
1890 "additionalProperties": {
1891 "type": "string"
1892 },
1893 "description": "Environment variables available to the appli cation.Only returned in GET requests if view=FULL is set.",
1894 "type": "object"
1895 },
1896 "livenessCheck": {
1897 "$ref": "LivenessCheck",
1898 "description": "Configures liveness health checking for VM i nstances. Unhealthy instances are stopped and replaced with new instancesOnly re turned in GET requests if view=FULL is set."
1899 },
1900 "network": {
1901 "$ref": "Network",
1902 "description": "Extra network settings. Only applicable for VM runtimes."
1903 },
1904 "betaSettings": {
1905 "additionalProperties": {
1906 "type": "string"
1907 },
1908 "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
1909 "type": "object"
1910 },
1911 "env": {
1912 "description": "App Engine execution environment for this ve rsion.Defaults to standard.",
1913 "type": "string"
1914 },
1915 "handlers": {
1916 "description": "An ordered list of URL-matching patterns tha t should be applied to incoming requests. The first matching URL handles the req uest and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
1917 "items": {
1918 "$ref": "UrlMap"
1919 },
1920 "type": "array"
1921 },
1922 "automaticScaling": {
1923 "$ref": "AutomaticScaling",
1924 "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
1925 },
1926 "diskUsageBytes": {
1927 "description": "Total size in bytes of all the files that ar e included in this version and curerntly hosted on the App Engine disk.@OutputOn ly",
1928 "format": "int64",
1929 "type": "string"
1930 },
1931 "healthCheck": {
1932 "$ref": "HealthCheck",
1933 "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicabl e for VM runtimes.Only returned in GET requests if view=FULL is set."
1934 },
1935 "threadsafe": {
1936 "description": "Whether multiple requests can be dispatched to this version at once.",
1937 "type": "boolean"
1938 },
1939 "readinessCheck": {
1940 "$ref": "ReadinessCheck",
1941 "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Onl y returned in GET requests if view=FULL is set."
1942 },
1943 "manualScaling": {
1944 "$ref": "ManualScaling",
1945 "description": "A service with manual scaling runs continuou sly, allowing you to perform complex initialization and rely on the state of its memory over time."
1946 },
1947 "name": {
1948 "description": "Full path to the Version resource in the API . Example: apps/myapp/services/default/versions/v1.@OutputOnly",
1949 "type": "string"
1950 },
1951 "apiConfig": {
1952 "$ref": "ApiConfigHandler",
1953 "description": "Serving configuration for Google Cloud Endpo ints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned i n GET requests if view=FULL is set."
1954 },
1955 "endpointsApiService": {
1956 "$ref": "EndpointsApiService",
1957 "description": "Cloud Endpoints configuration.If endpoints_a pi_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
1958 },
1959 "vm": {
1960 "description": "Whether to deploy this version in a containe r on a virtual machine.",
1961 "type": "boolean"
1962 },
1963 "versionUrl": {
1964 "description": "Serving URL for this version. Example: \"htt ps://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
1965 "type": "string"
1966 },
1967 "instanceClass": {
1968 "description": "Instance class that is used to run this vers ion. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or Ba sicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
1969 "type": "string"
1970 },
1971 "servingStatus": {
1972 "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_S TATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
1973 "enum": [ 2105 "enum": [
1974 "SERVING_STATUS_UNSPECIFIED", 2106 "ERROR_CODE_UNSPECIFIED",
1975 "SERVING", 2107 "ERROR_CODE_DEFAULT",
1976 "STOPPED" 2108 "ERROR_CODE_OVER_QUOTA",
2109 "ERROR_CODE_DOS_API_DENIAL",
2110 "ERROR_CODE_TIMEOUT"
1977 ], 2111 ],
1978 "enumDescriptions": [ 2112 "enumDescriptions": [
1979 "Not specified.", 2113 "Not specified. ERROR_CODE_DEFAULT is assumed.",
1980 "Currently serving. Instances are created according to t he scaling settings of the version.", 2114 "All other error types.",
1981 "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." 2115 "Application has exceeded a resource quota.",
1982 ], 2116 "Client blocked by the application's Denial of Service p rotection configuration.",
1983 "type": "string" 2117 "Deadline reached before the application responds."
1984 }, 2118 ],
1985 "deployment": { 2119 "type": "string"
1986 "$ref": "Deployment", 2120 },
1987 "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." 2121 "staticFile": {
1988 }, 2122 "description": "Static file content to be served for this er ror.",
1989 "runtimeApiVersion": { 2123 "type": "string"
1990 "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud .google.com/appengine/docs/standard/<language>/config/appref", 2124 }
1991 "type": "string" 2125 },
1992 }, 2126 "type": "object"
1993 "createTime": { 2127 },
1994 "description": "Time that this version was created.@OutputOn ly", 2128 "OperationMetadataV1": {
1995 "format": "google-datetime",
1996 "type": "string"
1997 },
1998 "resources": {
1999 "$ref": "Resources",
2000 "description": "Machine resources for this version. Only app licable for VM runtimes."
2001 },
2002 "inboundServices": {
2003 "description": "Before an application can receive email or X MPP messages, the application must be configured to enable the service.",
2004 "enumDescriptions": [
2005 "Not specified.",
2006 "Allows an application to receive mail.",
2007 "Allows an application to receive email-bound notificati ons.",
2008 "Allows an application to receive error stanzas.",
2009 "Allows an application to receive instant messages.",
2010 "Allows an application to receive user subscription POST s.",
2011 "Allows an application to receive a user's chat presence .",
2012 "Registers an application for notifications when a clien t connects or disconnects from a channel.",
2013 "Enables warmup requests."
2014 ],
2015 "items": {
2016 "enum": [
2017 "INBOUND_SERVICE_UNSPECIFIED",
2018 "INBOUND_SERVICE_MAIL",
2019 "INBOUND_SERVICE_MAIL_BOUNCE",
2020 "INBOUND_SERVICE_XMPP_ERROR",
2021 "INBOUND_SERVICE_XMPP_MESSAGE",
2022 "INBOUND_SERVICE_XMPP_SUBSCRIBE",
2023 "INBOUND_SERVICE_XMPP_PRESENCE",
2024 "INBOUND_SERVICE_CHANNEL_PRESENCE",
2025 "INBOUND_SERVICE_WARMUP"
2026 ],
2027 "type": "string"
2028 },
2029 "type": "array"
2030 },
2031 "errorHandlers": {
2032 "description": "Custom static error pages. Limited to 10KB p er page.Only returned in GET requests if view=FULL is set.",
2033 "items": {
2034 "$ref": "ErrorHandler"
2035 },
2036 "type": "array"
2037 },
2038 "defaultExpiration": {
2039 "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHan dler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.s ervices.versions#staticfileshandler) does not specify its own expiration time.On ly returned in GET requests if view=FULL is set.",
2040 "format": "google-duration",
2041 "type": "string"
2042 },
2043 "libraries": {
2044 "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
2045 "items": {
2046 "$ref": "Library"
2047 },
2048 "type": "array"
2049 },
2050 "nobuildFilesRegex": {
2051 "description": "Files that match this pattern will not be bu ilt into this version. Only applicable for Go runtimes.Only returned in GET requ ests if view=FULL is set.",
2052 "type": "string"
2053 }
2054 },
2055 "type": "object"
2056 },
2057 "RepairApplicationRequest": {
2058 "description": "Request message for 'Applications.RepairApplication' .",
2059 "id": "RepairApplicationRequest",
2060 "properties": {},
2061 "type": "object"
2062 },
2063 "ScriptHandler": {
2064 "description": "Executes a script to handle the request that matches the URL pattern.",
2065 "id": "ScriptHandler",
2066 "properties": {
2067 "scriptPath": {
2068 "description": "Path to the script from the application root directory.",
2069 "type": "string"
2070 }
2071 },
2072 "type": "object"
2073 },
2074 "FileInfo": {
2075 "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
2076 "id": "FileInfo",
2077 "properties": {
2078 "mimeType": {
2079 "description": "The MIME type of the file.Defaults to the va lue from Google Cloud Storage.",
2080 "type": "string"
2081 },
2082 "sourceUrl": {
2083 "description": "URL source to use to fetch this file. Must b e a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.goo gleapis.com/<bucket>/<object>'.",
2084 "type": "string"
2085 },
2086 "sha1Sum": {
2087 "description": "The SHA1 hash of the file, in hex.",
2088 "type": "string"
2089 }
2090 },
2091 "type": "object"
2092 },
2093 "OperationMetadataExperimental": {
2094 "description": "Metadata for the given google.longrunning.Operation. ", 2129 "description": "Metadata for the given google.longrunning.Operation. ",
2095 "id": "OperationMetadataExperimental", 2130 "id": "OperationMetadataV1",
2096 "properties": { 2131 "properties": {
2097 "method": {
2098 "description": "API method that initiated this operation. Ex ample: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnl y",
2099 "type": "string"
2100 },
2101 "insertTime": {
2102 "description": "Time that this operation was created.@Output Only",
2103 "format": "google-datetime",
2104 "type": "string"
2105 },
2106 "endTime": { 2132 "endTime": {
2107 "description": "Time that this operation completed.@OutputOn ly", 2133 "description": "Time that this operation completed.@OutputOn ly",
2108 "format": "google-datetime", 2134 "format": "google-datetime",
2109 "type": "string"
2110 },
2111 "target": {
2112 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
2113 "type": "string"
2114 },
2115 "user": {
2116 "description": "User who requested this operation.@OutputOnl y",
2117 "type": "string"
2118 }
2119 },
2120 "type": "object"
2121 },
2122 "TrafficSplit": {
2123 "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is ass igned to versions.",
2124 "id": "TrafficSplit",
2125 "properties": {
2126 "allocations": {
2127 "additionalProperties": {
2128 "format": "double",
2129 "type": "number"
2130 },
2131 "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version c an be specified only once, but some versions in the service may not have any tra ffic allocation. Services that have traffic allocated cannot be deleted until ei ther the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based split s and up to three decimal places is supported for cookie-based splits.",
2132 "type": "object"
2133 },
2134 "shardBy": {
2135 "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either ty pe until allocations are changed.",
2136 "enum": [
2137 "UNSPECIFIED",
2138 "COOKIE",
2139 "IP",
2140 "RANDOM"
2141 ],
2142 "enumDescriptions": [
2143 "Diversion method unspecified.",
2144 "Diversion based on a specially named cookie, \"GOOGAPPU ID.\" The cookie must be set by the application itself or no diversion will occu r.",
2145 "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
2146 "Diversion based on weighted random assignment. An incom ing request is randomly routed to a version in the traffic split, with probabili ty proportional to the version's traffic share."
2147 ],
2148 "type": "string"
2149 }
2150 },
2151 "type": "object"
2152 },
2153 "OperationMetadataV1Beta": {
2154 "description": "Metadata for the given google.longrunning.Operation. ",
2155 "id": "OperationMetadataV1Beta",
2156 "properties": {
2157 "method": {
2158 "description": "API method that initiated this operation. Ex ample: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
2159 "type": "string"
2160 },
2161 "endTime": {
2162 "description": "Time that this operation completed.@OutputOn ly",
2163 "format": "google-datetime",
2164 "type": "string" 2135 "type": "string"
2165 }, 2136 },
2166 "warning": { 2137 "warning": {
2167 "description": "Durable messages that persist on every opera tion poll. @OutputOnly", 2138 "description": "Durable messages that persist on every opera tion poll. @OutputOnly",
2168 "items": { 2139 "items": {
2169 "type": "string" 2140 "type": "string"
2170 }, 2141 },
2171 "type": "array" 2142 "type": "array"
2172 }, 2143 },
2173 "insertTime": { 2144 "insertTime": {
2174 "description": "Time that this operation was created.@Output Only", 2145 "description": "Time that this operation was created.@Output Only",
2175 "format": "google-datetime", 2146 "format": "google-datetime",
2176 "type": "string" 2147 "type": "string"
2177 }, 2148 },
2149 "user": {
2150 "description": "User who requested this operation.@OutputOnl y",
2151 "type": "string"
2152 },
2178 "target": { 2153 "target": {
2179 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", 2154 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
2180 "type": "string" 2155 "type": "string"
2181 }, 2156 },
2182 "user": {
2183 "description": "User who requested this operation.@OutputOnl y",
2184 "type": "string"
2185 },
2186 "ephemeralMessage": { 2157 "ephemeralMessage": {
2187 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", 2158 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
2188 "type": "string" 2159 "type": "string"
2189 } 2160 },
2190 }, 2161 "method": {
2191 "type": "object" 2162 "description": "API method that initiated this operation. Ex ample: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
2192 }, 2163 "type": "string"
2193 "ListServicesResponse": { 2164 }
2194 "description": "Response message for Services.ListServices.", 2165 },
2195 "id": "ListServicesResponse", 2166 "type": "object"
2196 "properties": { 2167 },
2197 "nextPageToken": { 2168 "Network": {
2198 "description": "Continuation token for fetching the next pag e of results.", 2169 "description": "Extra network settings. Only applicable for App Engi ne flexible environment versions",
2199 "type": "string" 2170 "id": "Network",
2200 }, 2171 "properties": {
2201 "services": { 2172 "subnetworkName": {
2202 "description": "The services belonging to the requested appl ication.", 2173 "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP addr ess is created from the IPCidrRange of the subnetwork that exists in that zone f or that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP addr ess is created from the IPCidrRange of the subnetwork.If specified, the subnetwo rk must exist in the same region as the App Engine flexible environment applicat ion.",
2203 "items": { 2174 "type": "string"
2204 "$ref": "Service" 2175 },
2205 }, 2176 "instanceTag": {
2206 "type": "array" 2177 "description": "Tag to apply to the VM instance during creat ion. Only applicable for for App Engine flexible environment versions.",
2207 } 2178 "type": "string"
2208 }, 2179 },
2209 "type": "object" 2180 "forwardedPorts": {
2210 }, 2181 "description": "List of ports, or port pairs, to forward fro m the virtual machine to the application container. Only applicable for App Engi ne flexible environment versions.",
2211 "Deployment": {
2212 "description": "Code and application artifacts used to deploy a vers ion to App Engine.",
2213 "id": "Deployment",
2214 "properties": {
2215 "zip": {
2216 "$ref": "ZipInfo",
2217 "description": "The zip file for this deployment, if this is a zip deployment."
2218 },
2219 "container": {
2220 "$ref": "ContainerInfo",
2221 "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible e nvironment."
2222 },
2223 "files": {
2224 "additionalProperties": {
2225 "$ref": "FileInfo"
2226 },
2227 "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable u sing the credentials supplied with this call.",
2228 "type": "object"
2229 }
2230 },
2231 "type": "object"
2232 },
2233 "Resources": {
2234 "description": "Machine resources for a version.",
2235 "id": "Resources",
2236 "properties": {
2237 "volumes": {
2238 "description": "User specified volumes.",
2239 "items": {
2240 "$ref": "Volume"
2241 },
2242 "type": "array"
2243 },
2244 "diskGb": {
2245 "description": "Disk size (GB) needed.",
2246 "format": "double",
2247 "type": "number"
2248 },
2249 "memoryGb": {
2250 "description": "Memory (GB) needed.",
2251 "format": "double",
2252 "type": "number"
2253 },
2254 "cpu": {
2255 "description": "Number of CPU cores needed.",
2256 "format": "double",
2257 "type": "number"
2258 }
2259 },
2260 "type": "object"
2261 },
2262 "Volume": {
2263 "description": "Volumes mounted within the app container. Only appli cable for VM runtimes.",
2264 "id": "Volume",
2265 "properties": {
2266 "sizeGb": {
2267 "description": "Volume size in gigabytes.",
2268 "format": "double",
2269 "type": "number"
2270 },
2271 "name": {
2272 "description": "Unique name for the volume.",
2273 "type": "string"
2274 },
2275 "volumeType": {
2276 "description": "Underlying volume type, e.g. 'tmpfs'.",
2277 "type": "string"
2278 }
2279 },
2280 "type": "object"
2281 },
2282 "ListInstancesResponse": {
2283 "description": "Response message for Instances.ListInstances.",
2284 "id": "ListInstancesResponse",
2285 "properties": {
2286 "instances": {
2287 "description": "The instances belonging to the requested ver sion.",
2288 "items": {
2289 "$ref": "Instance"
2290 },
2291 "type": "array"
2292 },
2293 "nextPageToken": {
2294 "description": "Continuation token for fetching the next pag e of results.",
2295 "type": "string"
2296 }
2297 },
2298 "type": "object"
2299 },
2300 "OperationMetadataV1Alpha": {
2301 "description": "Metadata for the given google.longrunning.Operation. ",
2302 "id": "OperationMetadataV1Alpha",
2303 "properties": {
2304 "warning": {
2305 "description": "Durable messages that persist on every opera tion poll. @OutputOnly",
2306 "items": { 2182 "items": {
2307 "type": "string" 2183 "type": "string"
2308 }, 2184 },
2309 "type": "array" 2185 "type": "array"
2310 }, 2186 },
2311 "insertTime": { 2187 "name": {
2312 "description": "Time that this operation was created.@Output Only", 2188 "description": "Google Compute Engine network where the virt ual machines are created. Specify the short name, not the resource path.Defaults to default.",
2313 "format": "google-datetime", 2189 "type": "string"
2314 "type": "string" 2190 }
2315 }, 2191 },
2316 "user": { 2192 "type": "object"
2317 "description": "User who requested this operation.@OutputOnl y", 2193 },
2318 "type": "string" 2194 "Application": {
2319 }, 2195 "description": "An Application resource contains the top-level confi guration of an App Engine application. Next tag: 20",
2320 "target": { 2196 "id": "Application",
2321 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", 2197 "properties": {
2322 "type": "string" 2198 "servingStatus": {
2323 }, 2199 "description": "Serving status of this application.",
2324 "ephemeralMessage": { 2200 "enum": [
2325 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", 2201 "UNSPECIFIED",
2326 "type": "string" 2202 "SERVING",
2327 }, 2203 "USER_DISABLED",
2328 "method": { 2204 "SYSTEM_DISABLED"
2329 "description": "API method that initiated this operation. Ex ample: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", 2205 ],
2330 "type": "string" 2206 "enumDescriptions": [
2331 }, 2207 "Serving status is unspecified.",
2332 "endTime": { 2208 "Application is serving.",
2333 "description": "Time that this operation completed.@OutputOn ly", 2209 "Application has been disabled by the user.",
2334 "format": "google-datetime", 2210 "Application has been disabled by the system."
2335 "type": "string" 2211 ],
2336 } 2212 "type": "string"
2337 }, 2213 },
2338 "type": "object" 2214 "defaultHostname": {
2339 }, 2215 "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
2340 "UrlDispatchRule": { 2216 "type": "string"
2341 "description": "Rules to match an HTTP request and dispatch that req uest to a service.", 2217 },
2342 "id": "UrlDispatchRule", 2218 "iap": {
2343 "properties": { 2219 "$ref": "IdentityAwareProxy"
2344 "service": { 2220 },
2345 "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", 2221 "authDomain": {
2346 "type": "string" 2222 "description": "Google Apps authentication domain that contr ols which users can access this application.Defaults to open access for any Goog le Account.",
2347 }, 2223 "type": "string"
2348 "domain": { 2224 },
2349 "description": "Domain name to match against. The wildcard \ "*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", 2225 "codeBucket": {
2350 "type": "string" 2226 "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated w ith the application and can be used by the gcloud deployment commands.@OutputOnl y",
2351 }, 2227 "type": "string"
2352 "path": { 2228 },
2353 "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the leng ths of the domain and path may not exceed 100 characters.", 2229 "defaultBucket": {
2354 "type": "string" 2230 "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
2355 } 2231 "type": "string"
2356 }, 2232 },
2357 "type": "object" 2233 "dispatchRules": {
2358 }, 2234 "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order -dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
2359 "ListVersionsResponse": {
2360 "description": "Response message for Versions.ListVersions.",
2361 "id": "ListVersionsResponse",
2362 "properties": {
2363 "versions": {
2364 "description": "The versions belonging to the requested serv ice.",
2365 "items": { 2235 "items": {
2366 "$ref": "Version" 2236 "$ref": "UrlDispatchRule"
2367 }, 2237 },
2368 "type": "array" 2238 "type": "array"
2369 }, 2239 },
2370 "nextPageToken": { 2240 "gcrDomain": {
2371 "description": "Continuation token for fetching the next pag e of results.", 2241 "description": "The Google Container Registry domain used fo r storing managed build docker images for this application.",
2372 "type": "string" 2242 "type": "string"
2373 } 2243 },
2374 },
2375 "type": "object"
2376 },
2377 "ApiEndpointHandler": {
2378 "description": "Uses Google Cloud Endpoints to handle requests.",
2379 "id": "ApiEndpointHandler",
2380 "properties": {
2381 "scriptPath": {
2382 "description": "Path to the script from the application root directory.",
2383 "type": "string"
2384 }
2385 },
2386 "type": "object"
2387 },
2388 "AutomaticScaling": {
2389 "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
2390 "id": "AutomaticScaling",
2391 "properties": {
2392 "diskUtilization": {
2393 "$ref": "DiskUtilization",
2394 "description": "Target scaling by disk usage."
2395 },
2396 "minPendingLatency": {
2397 "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
2398 "format": "google-duration",
2399 "type": "string"
2400 },
2401 "requestUtilization": {
2402 "$ref": "RequestUtilization",
2403 "description": "Target scaling by request utilization."
2404 },
2405 "maxIdleInstances": {
2406 "description": "Maximum number of idle instances that should be maintained for this version.",
2407 "format": "int32",
2408 "type": "integer"
2409 },
2410 "minIdleInstances": {
2411 "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a se rvice.",
2412 "format": "int32",
2413 "type": "integer"
2414 },
2415 "maxTotalInstances": {
2416 "description": "Maximum number of instances that should be s tarted to handle requests.",
2417 "format": "int32",
2418 "type": "integer"
2419 },
2420 "minTotalInstances": {
2421 "description": "Minimum number of instances that should be m aintained for this version.",
2422 "format": "int32",
2423 "type": "integer"
2424 },
2425 "networkUtilization": {
2426 "$ref": "NetworkUtilization",
2427 "description": "Target scaling by network usage."
2428 },
2429 "coolDownPeriod": {
2430 "description": "Amount of time that the Autoscaler (https:// cloud.google.com/compute/docs/autoscaler/) should wait between changes to the nu mber of virtual machines. Only applicable for VM runtimes.",
2431 "format": "google-duration",
2432 "type": "string"
2433 },
2434 "maxConcurrentRequests": {
2435 "description": "Number of concurrent requests an automatic s caling instance can accept before the scheduler spawns a new instance.Defaults t o a runtime-specific value.",
2436 "format": "int32",
2437 "type": "integer"
2438 },
2439 "maxPendingLatency": {
2440 "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
2441 "format": "google-duration",
2442 "type": "string"
2443 },
2444 "cpuUtilization": {
2445 "$ref": "CpuUtilization",
2446 "description": "Target scaling by CPU usage."
2447 }
2448 },
2449 "type": "object"
2450 },
2451 "ZipInfo": {
2452 "description": "The zip file information for a zip deployment.",
2453 "id": "ZipInfo",
2454 "properties": {
2455 "sourceUrl": {
2456 "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googl eapis.com/<bucket>/<object>'.",
2457 "type": "string"
2458 },
2459 "filesCount": {
2460 "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be s low.",
2461 "format": "int32",
2462 "type": "integer"
2463 }
2464 },
2465 "type": "object"
2466 },
2467 "Library": {
2468 "description": "Third-party Python runtime library that is required by the application.",
2469 "id": "Library",
2470 "properties": {
2471 "name": { 2244 "name": {
2472 "description": "Name of the library. Example: \"django\".", 2245 "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
2473 "type": "string" 2246 "type": "string"
2474 }, 2247 },
2475 "version": { 2248 "id": {
2476 "description": "Version of the library to select, or \"lates t\".", 2249 "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
2477 "type": "string" 2250 "type": "string"
2478 } 2251 },
2479 }, 2252 "defaultCookieExpiration": {
2480 "type": "object" 2253 "description": "Cookie expiration policy for this applicatio n.",
2481 }, 2254 "format": "google-duration",
2482 "ListLocationsResponse": { 2255 "type": "string"
2483 "description": "The response message for Locations.ListLocations.", 2256 },
2484 "id": "ListLocationsResponse", 2257 "locationId": {
2485 "properties": { 2258 "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Default s to us-central.Options are:us-central - Central USeurope-west - Western Europeu s-east1 - Eastern US",
2486 "nextPageToken": { 2259 "type": "string"
2487 "description": "The standard List next-page token.", 2260 }
2488 "type": "string" 2261 },
2489 }, 2262 "type": "object"
2490 "locations": { 2263 },
2491 "description": "A list of locations that matches the specifi ed filter in the request.", 2264 "Instance": {
2492 "items": { 2265 "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
2493 "$ref": "Location" 2266 "id": "Instance",
2267 "properties": {
2268 "averageLatency": {
2269 "description": "Average latency (ms) over the last minute.@O utputOnly",
2270 "format": "int32",
2271 "type": "integer"
2272 },
2273 "id": {
2274 "description": "Relative name of the instance within the ver sion. Example: instance-1.@OutputOnly",
2275 "type": "string"
2276 },
2277 "vmIp": {
2278 "description": "The IP address of this instance. Only applic able for instances in App Engine flexible environment.@OutputOnly",
2279 "type": "string"
2280 },
2281 "memoryUsage": {
2282 "description": "Total memory in use (bytes).@OutputOnly",
2283 "format": "int64",
2284 "type": "string"
2285 },
2286 "vmStatus": {
2287 "description": "Status of the virtual machine where this ins tance lives. Only applicable for instances in App Engine flexible environment.@O utputOnly",
2288 "type": "string"
2289 },
2290 "errors": {
2291 "description": "Number of errors since this instance was sta rted.@OutputOnly",
2292 "format": "int32",
2293 "type": "integer"
2294 },
2295 "availability": {
2296 "description": "Availability of the instance.@OutputOnly",
2297 "enum": [
2298 "UNSPECIFIED",
2299 "RESIDENT",
2300 "DYNAMIC"
2301 ],
2302 "enumDescriptions": [
2303 "",
2304 "",
2305 ""
2306 ],
2307 "type": "string"
2308 },
2309 "startTime": {
2310 "description": "Time that this instance was started.@OutputO nly",
2311 "format": "google-datetime",
2312 "type": "string"
2313 },
2314 "vmDebugEnabled": {
2315 "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
2316 "type": "boolean"
2317 },
2318 "requests": {
2319 "description": "Number of requests since this instance was s tarted.@OutputOnly",
2320 "format": "int32",
2321 "type": "integer"
2322 },
2323 "appEngineRelease": {
2324 "description": "App Engine release this instance is running on.@OutputOnly",
2325 "type": "string"
2326 },
2327 "vmName": {
2328 "description": "Name of the virtual machine where this insta nce lives. Only applicable for instances in App Engine flexible environment.@Out putOnly",
2329 "type": "string"
2330 },
2331 "qps": {
2332 "description": "Average queries per second (QPS) over the la st minute.@OutputOnly",
2333 "format": "float",
2334 "type": "number"
2335 },
2336 "vmId": {
2337 "description": "Virtual machine ID of this instance. Only ap plicable for instances in App Engine flexible environment.@OutputOnly",
2338 "type": "string"
2339 },
2340 "vmZoneName": {
2341 "description": "Zone where the virtual machine is located. O nly applicable for instances in App Engine flexible environment.@OutputOnly",
2342 "type": "string"
2343 },
2344 "name": {
2345 "description": "Full path to the Instance resource in the AP I. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@Output Only",
2346 "type": "string"
2347 }
2348 },
2349 "type": "object"
2350 },
2351 "LivenessCheck": {
2352 "description": "Health checking configuration for VM instances. Unhe althy instances are killed and replaced with new instances.",
2353 "id": "LivenessCheck",
2354 "properties": {
2355 "checkInterval": {
2356 "description": "Interval between health checks.",
2357 "format": "google-duration",
2358 "type": "string"
2359 },
2360 "timeout": {
2361 "description": "Time before the check is considered failed." ,
2362 "format": "google-duration",
2363 "type": "string"
2364 },
2365 "failureThreshold": {
2366 "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
2367 "format": "uint32",
2368 "type": "integer"
2369 },
2370 "initialDelay": {
2371 "description": "The initial delay before starting to execute the checks.",
2372 "format": "google-duration",
2373 "type": "string"
2374 },
2375 "path": {
2376 "description": "The request path.",
2377 "type": "string"
2378 },
2379 "host": {
2380 "description": "Host header to send when performing a HTTP L iveness check. Example: \"myapp.appspot.com\"",
2381 "type": "string"
2382 },
2383 "successThreshold": {
2384 "description": "Number of consecutive successful checks requ ired before considering the VM healthy.",
2385 "format": "uint32",
2386 "type": "integer"
2387 }
2388 },
2389 "type": "object"
2390 },
2391 "NetworkUtilization": {
2392 "description": "Target scaling by network usage. Only applicable for VM runtimes.",
2393 "id": "NetworkUtilization",
2394 "properties": {
2395 "targetSentBytesPerSecond": {
2396 "description": "Target bytes sent per second.",
2397 "format": "int32",
2398 "type": "integer"
2399 },
2400 "targetReceivedBytesPerSecond": {
2401 "description": "Target bytes received per second.",
2402 "format": "int32",
2403 "type": "integer"
2404 },
2405 "targetSentPacketsPerSecond": {
2406 "description": "Target packets sent per second.",
2407 "format": "int32",
2408 "type": "integer"
2409 },
2410 "targetReceivedPacketsPerSecond": {
2411 "description": "Target packets received per second.",
2412 "format": "int32",
2413 "type": "integer"
2414 }
2415 },
2416 "type": "object"
2417 },
2418 "Location": {
2419 "description": "A resource that represents Google Cloud Platform loc ation.",
2420 "id": "Location",
2421 "properties": {
2422 "labels": {
2423 "additionalProperties": {
2424 "type": "string"
2494 }, 2425 },
2495 "type": "array" 2426 "description": "Cross-service attributes for the location. F or example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
2496 } 2427 "type": "object"
2497 }, 2428 },
2498 "type": "object" 2429 "name": {
2499 }, 2430 "description": "Resource name for the location, which may va ry between implementations. For example: \"projects/example-project/locations/us -east1\"",
2500 "ContainerInfo": { 2431 "type": "string"
2501 "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instanc es running in the App Engine flexible environment.", 2432 },
2502 "id": "ContainerInfo", 2433 "locationId": {
2503 "properties": { 2434 "description": "The canonical id for this location. For exam ple: \"us-east1\".",
2504 "image": { 2435 "type": "string"
2505 "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\" ", 2436 },
2506 "type": "string" 2437 "metadata": {
2507 } 2438 "additionalProperties": {
2508 }, 2439 "description": "Properties of the object. Contains field @type with type URL.",
2509 "type": "object" 2440 "type": "any"
2510 }, 2441 },
2511 "RequestUtilization": { 2442 "description": "Service-specific metadata. For example the a vailable capacity at the given location.",
2512 "description": "Target scaling by request utilization. Only applicab le for VM runtimes.", 2443 "type": "object"
2513 "id": "RequestUtilization", 2444 }
2514 "properties": { 2445 },
2515 "targetRequestCountPerSecond": { 2446 "type": "object"
2516 "description": "Target requests per second.", 2447 },
2517 "format": "int32", 2448 "HealthCheck": {
2518 "type": "integer" 2449 "description": "Health checking configuration for VM instances. Unhe althy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
2519 }, 2450 "id": "HealthCheck",
2520 "targetConcurrentRequests": { 2451 "properties": {
2521 "description": "Target number of concurrent requests.", 2452 "host": {
2522 "format": "int32", 2453 "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
2523 "type": "integer" 2454 "type": "string"
2524 } 2455 },
2525 }, 2456 "healthyThreshold": {
2526 "type": "object" 2457 "description": "Number of consecutive successful health chec ks required before receiving traffic.",
2458 "format": "uint32",
2459 "type": "integer"
2460 },
2461 "restartThreshold": {
2462 "description": "Number of consecutive failed health checks r equired before an instance is restarted.",
2463 "format": "uint32",
2464 "type": "integer"
2465 },
2466 "checkInterval": {
2467 "description": "Interval between health checks.",
2468 "format": "google-duration",
2469 "type": "string"
2470 },
2471 "timeout": {
2472 "description": "Time before the health check is considered f ailed.",
2473 "format": "google-duration",
2474 "type": "string"
2475 },
2476 "unhealthyThreshold": {
2477 "description": "Number of consecutive failed health checks r equired before removing traffic.",
2478 "format": "uint32",
2479 "type": "integer"
2480 },
2481 "disableHealthCheck": {
2482 "description": "Whether to explicitly disable health checks for this instance.",
2483 "type": "boolean"
2484 }
2485 },
2486 "type": "object"
2487 },
2488 "ReadinessCheck": {
2489 "description": "Readiness checking configuration for VM instances. U nhealthy instances are removed from traffic rotation.",
2490 "id": "ReadinessCheck",
2491 "properties": {
2492 "timeout": {
2493 "description": "Time before the check is considered failed." ,
2494 "format": "google-duration",
2495 "type": "string"
2496 },
2497 "failureThreshold": {
2498 "description": "Number of consecutive failed checks required before removing traffic.",
2499 "format": "uint32",
2500 "type": "integer"
2501 },
2502 "appStartTimeout": {
2503 "description": "A maximum time limit on application initiali zation, measured from moment the application successfully replies to a healthche ck until it is ready to serve traffic.",
2504 "format": "google-duration",
2505 "type": "string"
2506 },
2507 "path": {
2508 "description": "The request path.",
2509 "type": "string"
2510 },
2511 "successThreshold": {
2512 "description": "Number of consecutive successful checks requ ired before receiving traffic.",
2513 "format": "uint32",
2514 "type": "integer"
2515 },
2516 "host": {
2517 "description": "Host header to send when performing a HTTP R eadiness check. Example: \"myapp.appspot.com\"",
2518 "type": "string"
2519 },
2520 "checkInterval": {
2521 "description": "Interval between health checks.",
2522 "format": "google-duration",
2523 "type": "string"
2524 }
2525 },
2526 "type": "object"
2527 } 2527 }
2528 }, 2528 },
2529 "servicePath": "", 2529 "servicePath": "",
2530 "title": "Google App Engine Admin API", 2530 "title": "Google App Engine Admin API",
2531 "version": "v1" 2531 "version": "v1"
2532 } 2532 }
OLDNEW
« no previous file with comments | « discovery/googleapis/androidpublisher__v2.json ('k') | discovery/googleapis/appstate__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698