OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 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 } |
| 9 } |
| 10 }, |
| 11 "basePath": "", |
| 12 "baseUrl": "https://appengine.googleapis.com/", |
| 13 "batchPath": "batch", |
| 14 "description": "The App Engine Admin API enables developers to provision and
manage their App Engine applications.", |
| 15 "discoveryVersion": "v1", |
| 16 "documentationLink": "https://developers.google.com/appengine/", |
| 17 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/5-TWXZdLOUBo15RKT-gc4uxrObI\"", |
| 18 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, |
| 22 "id": "appengine:v1beta4", |
| 23 "kind": "discovery#restDescription", |
| 24 "name": "appengine", |
| 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", |
| 27 "parameters": { |
| 28 "access_token": { |
| 29 "description": "OAuth access token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "alt": { |
| 34 "default": "json", |
| 35 "description": "Data format for response.", |
| 36 "enumDescriptions": [ |
| 37 "Responses with Content-Type of application/json", |
| 38 "Media download with context-dependent Content-Type", |
| 39 "Responses with Content-Type of application/x-protobuf" |
| 40 ], |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "bearer_token": { |
| 45 "description": "OAuth bearer token.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "callback": { |
| 50 "description": "JSONP", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
| 54 "fields": { |
| 55 "description": "Selector specifying which fields to include in a par
tial response.", |
| 56 "location": "query", |
| 57 "type": "string" |
| 58 }, |
| 59 "key": { |
| 60 "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.", |
| 61 "location": "query", |
| 62 "type": "string" |
| 63 }, |
| 64 "oauth_token": { |
| 65 "description": "OAuth 2.0 token for the current user.", |
| 66 "location": "query", |
| 67 "type": "string" |
| 68 }, |
| 69 "pp": { |
| 70 "default": "true", |
| 71 "description": "Pretty-print response.", |
| 72 "location": "query", |
| 73 "type": "boolean" |
| 74 }, |
| 75 "prettyPrint": { |
| 76 "default": "true", |
| 77 "description": "Returns response with indentations and line breaks."
, |
| 78 "location": "query", |
| 79 "type": "boolean" |
| 80 }, |
| 81 "quotaUser": { |
| 82 "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.", |
| 83 "location": "query", |
| 84 "type": "string" |
| 85 }, |
| 86 "upload_protocol": { |
| 87 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
| 91 "uploadType": { |
| 92 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 93 "location": "query", |
| 94 "type": "string" |
| 95 }, |
| 96 "$.xgafv": { |
| 97 "description": "V1 error format.", |
| 98 "enumDescriptions": [ |
| 99 "v1 error format", |
| 100 "v2 error format" |
| 101 ], |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 } |
| 105 }, |
| 106 "protocol": "rest", |
| 107 "resources": { |
| 108 "apps": { |
| 109 "methods": { |
| 110 "get": { |
| 111 "description": "Gets information about an application.", |
| 112 "httpMethod": "GET", |
| 113 "id": "appengine.apps.get", |
| 114 "parameterOrder": [ |
| 115 "appsId" |
| 116 ], |
| 117 "parameters": { |
| 118 "appsId": { |
| 119 "description": "Part of `name`. Name of the applicat
ion to get. For example: \"apps/myapp\".", |
| 120 "location": "path", |
| 121 "required": true, |
| 122 "type": "string" |
| 123 }, |
| 124 "ensureResourcesExist": { |
| 125 "description": "Certain resources associated with an
application are created on-demand. Controls whether these resources should be c
reated when performing the `GET` operation. If specified and any resources cloud
not be created, the request will fail with an error code.", |
| 126 "location": "query", |
| 127 "type": "boolean" |
| 128 } |
| 129 }, |
| 130 "path": "v1beta4/apps/{appsId}", |
| 131 "response": { |
| 132 "$ref": "Application" |
| 133 }, |
| 134 "scopes": [ |
| 135 "https://www.googleapis.com/auth/cloud-platform" |
| 136 ] |
| 137 } |
| 138 }, |
| 139 "resources": { |
| 140 "modules": { |
| 141 "methods": { |
| 142 "delete": { |
| 143 "description": "Deletes a module and all enclosed ve
rsions.", |
| 144 "httpMethod": "DELETE", |
| 145 "id": "appengine.apps.modules.delete", |
| 146 "parameterOrder": [ |
| 147 "appsId", |
| 148 "modulesId" |
| 149 ], |
| 150 "parameters": { |
| 151 "appsId": { |
| 152 "description": "Part of `name`. Name of the
resource requested. For example: \"apps/myapp/modules/default\".", |
| 153 "location": "path", |
| 154 "required": true, |
| 155 "type": "string" |
| 156 }, |
| 157 "modulesId": { |
| 158 "description": "Part of `name`. See document
ation of `appsId`.", |
| 159 "location": "path", |
| 160 "required": true, |
| 161 "type": "string" |
| 162 } |
| 163 }, |
| 164 "path": "v1beta4/apps/{appsId}/modules/{modulesId}", |
| 165 "response": { |
| 166 "$ref": "Operation" |
| 167 }, |
| 168 "scopes": [ |
| 169 "https://www.googleapis.com/auth/cloud-platform" |
| 170 ] |
| 171 }, |
| 172 "get": { |
| 173 "description": "Gets the current configuration of th
e module.", |
| 174 "httpMethod": "GET", |
| 175 "id": "appengine.apps.modules.get", |
| 176 "parameterOrder": [ |
| 177 "appsId", |
| 178 "modulesId" |
| 179 ], |
| 180 "parameters": { |
| 181 "appsId": { |
| 182 "description": "Part of `name`. Name of the
resource requested. For example: \"/apps/myapp/modules/default\".", |
| 183 "location": "path", |
| 184 "required": true, |
| 185 "type": "string" |
| 186 }, |
| 187 "modulesId": { |
| 188 "description": "Part of `name`. See document
ation of `appsId`.", |
| 189 "location": "path", |
| 190 "required": true, |
| 191 "type": "string" |
| 192 } |
| 193 }, |
| 194 "path": "v1beta4/apps/{appsId}/modules/{modulesId}", |
| 195 "response": { |
| 196 "$ref": "Module" |
| 197 }, |
| 198 "scopes": [ |
| 199 "https://www.googleapis.com/auth/cloud-platform" |
| 200 ] |
| 201 }, |
| 202 "list": { |
| 203 "description": "Lists all the modules in the applica
tion.", |
| 204 "httpMethod": "GET", |
| 205 "id": "appengine.apps.modules.list", |
| 206 "parameterOrder": [ |
| 207 "appsId" |
| 208 ], |
| 209 "parameters": { |
| 210 "appsId": { |
| 211 "description": "Part of `name`. Name of the
resource requested. For example: \"/apps/myapp\".", |
| 212 "location": "path", |
| 213 "required": true, |
| 214 "type": "string" |
| 215 }, |
| 216 "pageSize": { |
| 217 "description": "Maximum results to return pe
r page.", |
| 218 "format": "int32", |
| 219 "location": "query", |
| 220 "type": "integer" |
| 221 }, |
| 222 "pageToken": { |
| 223 "description": "Continuation token for fetch
ing the next page of results.", |
| 224 "location": "query", |
| 225 "type": "string" |
| 226 } |
| 227 }, |
| 228 "path": "v1beta4/apps/{appsId}/modules", |
| 229 "response": { |
| 230 "$ref": "ListModulesResponse" |
| 231 }, |
| 232 "scopes": [ |
| 233 "https://www.googleapis.com/auth/cloud-platform" |
| 234 ] |
| 235 }, |
| 236 "patch": { |
| 237 "description": "Updates the configuration of the spe
cified module.", |
| 238 "httpMethod": "PATCH", |
| 239 "id": "appengine.apps.modules.patch", |
| 240 "parameterOrder": [ |
| 241 "appsId", |
| 242 "modulesId" |
| 243 ], |
| 244 "parameters": { |
| 245 "appsId": { |
| 246 "description": "Part of `name`. Name of the
resource to update. For example: \"apps/myapp/modules/default\".", |
| 247 "location": "path", |
| 248 "required": true, |
| 249 "type": "string" |
| 250 }, |
| 251 "modulesId": { |
| 252 "description": "Part of `name`. See document
ation of `appsId`.", |
| 253 "location": "path", |
| 254 "required": true, |
| 255 "type": "string" |
| 256 }, |
| 257 "mask": { |
| 258 "description": "Standard field mask for the
set of fields to be updated.", |
| 259 "location": "query", |
| 260 "type": "string" |
| 261 }, |
| 262 "migrateTraffic": { |
| 263 "description": "Whether to use Traffic Migra
tion to shift traffic gradually. Traffic can only be migrated from a single vers
ion to another single version.", |
| 264 "location": "query", |
| 265 "type": "boolean" |
| 266 } |
| 267 }, |
| 268 "path": "v1beta4/apps/{appsId}/modules/{modulesId}", |
| 269 "request": { |
| 270 "$ref": "Module" |
| 271 }, |
| 272 "response": { |
| 273 "$ref": "Operation" |
| 274 }, |
| 275 "scopes": [ |
| 276 "https://www.googleapis.com/auth/cloud-platform" |
| 277 ] |
| 278 } |
| 279 }, |
| 280 "resources": { |
| 281 "versions": { |
| 282 "methods": { |
| 283 "create": { |
| 284 "description": "Deploys new code and resourc
e files to a version.", |
| 285 "httpMethod": "POST", |
| 286 "id": "appengine.apps.modules.versions.creat
e", |
| 287 "parameterOrder": [ |
| 288 "appsId", |
| 289 "modulesId" |
| 290 ], |
| 291 "parameters": { |
| 292 "appsId": { |
| 293 "description": "Part of `name`. Name
of the resource to update. For example: \"apps/myapp/modules/default\".", |
| 294 "location": "path", |
| 295 "required": true, |
| 296 "type": "string" |
| 297 }, |
| 298 "modulesId": { |
| 299 "description": "Part of `name`. See
documentation of `appsId`.", |
| 300 "location": "path", |
| 301 "required": true, |
| 302 "type": "string" |
| 303 } |
| 304 }, |
| 305 "path": "v1beta4/apps/{appsId}/modules/{modu
lesId}/versions", |
| 306 "request": { |
| 307 "$ref": "Version" |
| 308 }, |
| 309 "response": { |
| 310 "$ref": "Operation" |
| 311 }, |
| 312 "scopes": [ |
| 313 "https://www.googleapis.com/auth/cloud-p
latform" |
| 314 ] |
| 315 }, |
| 316 "delete": { |
| 317 "description": "Deletes an existing version.
", |
| 318 "httpMethod": "DELETE", |
| 319 "id": "appengine.apps.modules.versions.delet
e", |
| 320 "parameterOrder": [ |
| 321 "appsId", |
| 322 "modulesId", |
| 323 "versionsId" |
| 324 ], |
| 325 "parameters": { |
| 326 "appsId": { |
| 327 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/modules/default/versions/v
1\".", |
| 328 "location": "path", |
| 329 "required": true, |
| 330 "type": "string" |
| 331 }, |
| 332 "modulesId": { |
| 333 "description": "Part of `name`. See
documentation of `appsId`.", |
| 334 "location": "path", |
| 335 "required": true, |
| 336 "type": "string" |
| 337 }, |
| 338 "versionsId": { |
| 339 "description": "Part of `name`. See
documentation of `appsId`.", |
| 340 "location": "path", |
| 341 "required": true, |
| 342 "type": "string" |
| 343 } |
| 344 }, |
| 345 "path": "v1beta4/apps/{appsId}/modules/{modu
lesId}/versions/{versionsId}", |
| 346 "response": { |
| 347 "$ref": "Operation" |
| 348 }, |
| 349 "scopes": [ |
| 350 "https://www.googleapis.com/auth/cloud-p
latform" |
| 351 ] |
| 352 }, |
| 353 "get": { |
| 354 "description": "Gets application deployment
information.", |
| 355 "httpMethod": "GET", |
| 356 "id": "appengine.apps.modules.versions.get", |
| 357 "parameterOrder": [ |
| 358 "appsId", |
| 359 "modulesId", |
| 360 "versionsId" |
| 361 ], |
| 362 "parameters": { |
| 363 "appsId": { |
| 364 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/modules/default/versions/v
1\".", |
| 365 "location": "path", |
| 366 "required": true, |
| 367 "type": "string" |
| 368 }, |
| 369 "modulesId": { |
| 370 "description": "Part of `name`. See
documentation of `appsId`.", |
| 371 "location": "path", |
| 372 "required": true, |
| 373 "type": "string" |
| 374 }, |
| 375 "versionsId": { |
| 376 "description": "Part of `name`. See
documentation of `appsId`.", |
| 377 "location": "path", |
| 378 "required": true, |
| 379 "type": "string" |
| 380 }, |
| 381 "view": { |
| 382 "description": "Controls the set of
fields returned in the `Get` response.", |
| 383 "enum": [ |
| 384 "BASIC", |
| 385 "FULL" |
| 386 ], |
| 387 "location": "query", |
| 388 "type": "string" |
| 389 } |
| 390 }, |
| 391 "path": "v1beta4/apps/{appsId}/modules/{modu
lesId}/versions/{versionsId}", |
| 392 "response": { |
| 393 "$ref": "Version" |
| 394 }, |
| 395 "scopes": [ |
| 396 "https://www.googleapis.com/auth/cloud-p
latform" |
| 397 ] |
| 398 }, |
| 399 "list": { |
| 400 "description": "Lists the versions of a modu
le.", |
| 401 "httpMethod": "GET", |
| 402 "id": "appengine.apps.modules.versions.list"
, |
| 403 "parameterOrder": [ |
| 404 "appsId", |
| 405 "modulesId" |
| 406 ], |
| 407 "parameters": { |
| 408 "appsId": { |
| 409 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/modules/default\".", |
| 410 "location": "path", |
| 411 "required": true, |
| 412 "type": "string" |
| 413 }, |
| 414 "modulesId": { |
| 415 "description": "Part of `name`. See
documentation of `appsId`.", |
| 416 "location": "path", |
| 417 "required": true, |
| 418 "type": "string" |
| 419 }, |
| 420 "view": { |
| 421 "description": "Controls the set of
fields returned in the `List` response.", |
| 422 "enum": [ |
| 423 "BASIC", |
| 424 "FULL" |
| 425 ], |
| 426 "location": "query", |
| 427 "type": "string" |
| 428 }, |
| 429 "pageSize": { |
| 430 "description": "Maximum results to r
eturn per page.", |
| 431 "format": "int32", |
| 432 "location": "query", |
| 433 "type": "integer" |
| 434 }, |
| 435 "pageToken": { |
| 436 "description": "Continuation token f
or fetching the next page of results.", |
| 437 "location": "query", |
| 438 "type": "string" |
| 439 } |
| 440 }, |
| 441 "path": "v1beta4/apps/{appsId}/modules/{modu
lesId}/versions", |
| 442 "response": { |
| 443 "$ref": "ListVersionsResponse" |
| 444 }, |
| 445 "scopes": [ |
| 446 "https://www.googleapis.com/auth/cloud-p
latform" |
| 447 ] |
| 448 } |
| 449 } |
| 450 } |
| 451 } |
| 452 }, |
| 453 "operations": { |
| 454 "methods": { |
| 455 "get": { |
| 456 "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.", |
| 457 "httpMethod": "GET", |
| 458 "id": "appengine.apps.operations.get", |
| 459 "parameterOrder": [ |
| 460 "appsId", |
| 461 "operationsId" |
| 462 ], |
| 463 "parameters": { |
| 464 "appsId": { |
| 465 "description": "Part of `name`. The name of
the operation resource.", |
| 466 "location": "path", |
| 467 "required": true, |
| 468 "type": "string" |
| 469 }, |
| 470 "operationsId": { |
| 471 "description": "Part of `name`. See document
ation of `appsId`.", |
| 472 "location": "path", |
| 473 "required": true, |
| 474 "type": "string" |
| 475 } |
| 476 }, |
| 477 "path": "v1beta4/apps/{appsId}/operations/{operation
sId}", |
| 478 "response": { |
| 479 "$ref": "Operation" |
| 480 }, |
| 481 "scopes": [ |
| 482 "https://www.googleapis.com/auth/cloud-platform" |
| 483 ] |
| 484 }, |
| 485 "list": { |
| 486 "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 below allows API services to overri
de the binding to use different resource name schemes, such as `users/*/operatio
ns`.", |
| 487 "httpMethod": "GET", |
| 488 "id": "appengine.apps.operations.list", |
| 489 "parameterOrder": [ |
| 490 "appsId" |
| 491 ], |
| 492 "parameters": { |
| 493 "appsId": { |
| 494 "description": "Part of `name`. The name of
the operation collection.", |
| 495 "location": "path", |
| 496 "required": true, |
| 497 "type": "string" |
| 498 }, |
| 499 "filter": { |
| 500 "description": "The standard List filter.", |
| 501 "location": "query", |
| 502 "type": "string" |
| 503 }, |
| 504 "pageSize": { |
| 505 "description": "The standard List page size.
", |
| 506 "format": "int32", |
| 507 "location": "query", |
| 508 "type": "integer" |
| 509 }, |
| 510 "pageToken": { |
| 511 "description": "The standard List page token
.", |
| 512 "location": "query", |
| 513 "type": "string" |
| 514 } |
| 515 }, |
| 516 "path": "v1beta4/apps/{appsId}/operations", |
| 517 "response": { |
| 518 "$ref": "ListOperationsResponse" |
| 519 }, |
| 520 "scopes": [ |
| 521 "https://www.googleapis.com/auth/cloud-platform" |
| 522 ] |
| 523 } |
| 524 } |
| 525 } |
| 526 } |
| 527 } |
| 528 }, |
| 529 "revision": "20150720", |
| 530 "rootUrl": "https://appengine.googleapis.com/", |
| 531 "schemas": { |
| 532 "Application": { |
| 533 "description": "An Application contains the top-level configuration
of an App Engine application.", |
| 534 "id": "Application", |
| 535 "properties": { |
| 536 "name": { |
| 537 "description": "The full path to the application in the API.
Example: \"apps/myapp\". @OutputOnly", |
| 538 "type": "string" |
| 539 }, |
| 540 "id": { |
| 541 "description": "The relative name/path of the application. E
xample: \"myapp\". @OutputOnly", |
| 542 "type": "string" |
| 543 }, |
| 544 "dispatchRules": { |
| 545 "description": "HTTP path dispatch rules for requests to the
app that do not explicitly target a module or version. The rules are order-depe
ndent.", |
| 546 "items": { |
| 547 "$ref": "UrlDispatchRule" |
| 548 }, |
| 549 "type": "array" |
| 550 }, |
| 551 "location": { |
| 552 "description": "The location from which the application will
be run. Choices are \"us\" for United States and \"eu\" for European Union. App
lication instances will run out of data centers in the chosen location and all o
f the application's End User Content will be stored at rest in the chosen locati
on. The default is \"us\".", |
| 553 "type": "string" |
| 554 }, |
| 555 "codeBucket": { |
| 556 "description": "A Google Cloud Storage bucket which can be u
sed for storing files associated with an application. This bucket is associated
with the application and can be used by the gcloud deployment commands. @OutputO
nly", |
| 557 "type": "string" |
| 558 } |
| 559 }, |
| 560 "type": "object" |
| 561 }, |
| 562 "UrlDispatchRule": { |
| 563 "description": "Rules to match an HTTP request and dispatch that req
uest to a module.", |
| 564 "id": "UrlDispatchRule", |
| 565 "properties": { |
| 566 "domain": { |
| 567 "description": "The domain name to match on. Supports '*' (g
lob) wildcarding on the left-hand side of a '.'. If empty, all domains will be m
atched (the same as '*').", |
| 568 "type": "string" |
| 569 }, |
| 570 "path": { |
| 571 "description": "The pathname within the host. This must star
t with a '/'. A single '*' (glob) can be included at the end of the path. The su
m of the lengths of the domain and path may not exceed 100 characters.", |
| 572 "type": "string" |
| 573 }, |
| 574 "module": { |
| 575 "description": "The resource id of a Module in this applicat
ion that should service the matched request. The Module must already exist. Exam
ple: \"default\".", |
| 576 "type": "string" |
| 577 } |
| 578 }, |
| 579 "type": "object" |
| 580 }, |
| 581 "Version": { |
| 582 "description": "A Version is a specific set of source code and confi
guration files deployed to a module.", |
| 583 "id": "Version", |
| 584 "properties": { |
| 585 "name": { |
| 586 "description": "The full path to the Version resource in the
API. Example: \"apps/myapp/modules/default/versions/v1\". @OutputOnly", |
| 587 "type": "string" |
| 588 }, |
| 589 "id": { |
| 590 "description": "The relative name/path of the Version within
the module. Example: \"v1\"", |
| 591 "type": "string" |
| 592 }, |
| 593 "automaticScaling": { |
| 594 "$ref": "AutomaticScaling", |
| 595 "description": "Automatic scaling is the scaling policy that
App Engine has used since its inception. It is based on request rate, response
latencies, and other application metrics." |
| 596 }, |
| 597 "basicScaling": { |
| 598 "$ref": "BasicScaling", |
| 599 "description": "A module with basic scaling will create an i
nstance when the application receives a request. The instance will be turned dow
n when the app becomes idle. Basic scaling is ideal for work that is intermitten
t or driven by user activity." |
| 600 }, |
| 601 "manualScaling": { |
| 602 "$ref": "ManualScaling", |
| 603 "description": "A module with manual scaling runs continuous
ly, allowing you to perform complex initialization and rely on the state of its
memory over time." |
| 604 }, |
| 605 "inboundServices": { |
| 606 "description": "Before an application can receive email or X
MPP messages, the application must be configured to enable the service.", |
| 607 "enumDescriptions": [ |
| 608 "Not specified.", |
| 609 "Allows an application to receive mail.", |
| 610 "Allows an application receive email bound notifications
.", |
| 611 "Allows an application to receive error stanzas.", |
| 612 "Allows an application to receive instant messages.", |
| 613 "Allows an application to receive user subscription POST
s.", |
| 614 "Allows an application to receive a user's chat presence
.", |
| 615 "Registers an application for notifications when a clien
t connects or disconnects from a channel.", |
| 616 "Enables warmup requests." |
| 617 ], |
| 618 "items": { |
| 619 "enum": [ |
| 620 "INBOUND_SERVICE_UNSPECIFIED", |
| 621 "INBOUND_SERVICE_MAIL", |
| 622 "INBOUND_SERVICE_MAIL_BOUNCE", |
| 623 "INBOUND_SERVICE_XMPP_ERROR", |
| 624 "INBOUND_SERVICE_XMPP_MESSAGE", |
| 625 "INBOUND_SERVICE_XMPP_SUBSCRIBE", |
| 626 "INBOUND_SERVICE_XMPP_PRESENCE", |
| 627 "INBOUND_SERVICE_CHANNEL_PRESENCE", |
| 628 "INBOUND_SERVICE_WARMUP" |
| 629 ], |
| 630 "type": "string" |
| 631 }, |
| 632 "type": "array" |
| 633 }, |
| 634 "instanceClass": { |
| 635 "description": "The frontend instance class to use to run th
is app. Valid values are `[F1, F2, F4, F4_1G]`.", |
| 636 "type": "string" |
| 637 }, |
| 638 "network": { |
| 639 "$ref": "Network", |
| 640 "description": "Used to specify extra network settings (for
VM runtimes only)." |
| 641 }, |
| 642 "resources": { |
| 643 "$ref": "Resources", |
| 644 "description": "Used to specify how many machine resources a
n app version needs (for VM runtimes only)." |
| 645 }, |
| 646 "runtime": { |
| 647 "description": "The desired runtime. Values can include pyth
on27, java7, go, etc.", |
| 648 "type": "string" |
| 649 }, |
| 650 "threadsafe": { |
| 651 "description": "If true, multiple requests can be dispatched
to the app at once.", |
| 652 "type": "boolean" |
| 653 }, |
| 654 "vm": { |
| 655 "description": "Whether to deploy this app in a VM container
.", |
| 656 "type": "boolean" |
| 657 }, |
| 658 "betaSettings": { |
| 659 "additionalProperties": { |
| 660 "type": "string" |
| 661 }, |
| 662 "description": "Beta settings supplied to the application vi
a metadata.", |
| 663 "type": "object" |
| 664 }, |
| 665 "handlers": { |
| 666 "description": "An ordered list of URL Matching patterns tha
t should be applied to incoming requests. The first matching URL consumes the re
quest, and subsequent handlers are not attempted. Only returned in `GET` request
s if `view=FULL` is set. May only be set on create requests; once created, is im
mutable.", |
| 667 "items": { |
| 668 "$ref": "UrlMap" |
| 669 }, |
| 670 "type": "array" |
| 671 }, |
| 672 "errorHandlers": { |
| 673 "description": "Custom static error pages instead of these g
eneric error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=
FULL` is set. May only be set on create requests; once created, is immutable.", |
| 674 "items": { |
| 675 "$ref": "ErrorHandler" |
| 676 }, |
| 677 "type": "array" |
| 678 }, |
| 679 "libraries": { |
| 680 "description": "Configuration for Python runtime third-party
libraries required by the application. Only returned in `GET` requests if `view
=FULL` is set. May only be set on create requests; once created, is immutable.", |
| 681 "items": { |
| 682 "$ref": "Library" |
| 683 }, |
| 684 "type": "array" |
| 685 }, |
| 686 "apiConfig": { |
| 687 "$ref": "ApiConfigHandler", |
| 688 "description": "Serving configuration for Google Cloud Endpo
ints. Only returned in `GET` requests if `view=FULL` is set. May only be set on
create requests; once created, is immutable." |
| 689 }, |
| 690 "envVariables": { |
| 691 "additionalProperties": { |
| 692 "type": "string" |
| 693 }, |
| 694 "description": "Environment variables made available to the
application. Only returned in `GET` requests if `view=FULL` is set. May only be
set on create requests; once created, is immutable.", |
| 695 "type": "object" |
| 696 }, |
| 697 "defaultExpiration": { |
| 698 "description": "The length of time a static file served by a
static file handler ought to be cached by web proxies and browsers, if the hand
ler does not specify its own expiration. Only returned in `GET` requests if `vie
w=FULL` is set. May only be set on create requests; once created, is immutable."
, |
| 699 "type": "string" |
| 700 }, |
| 701 "healthCheck": { |
| 702 "$ref": "HealthCheck", |
| 703 "description": "Configure health checking for the VM instanc
es. Unhealthy VM instances will be stopped and replaced with new instances. Only
returned in `GET` requests if `view=FULL` is set. May only be set on create req
uests; once created, is immutable." |
| 704 }, |
| 705 "nobuildFilesRegex": { |
| 706 "description": "Go only. Files that match this pattern will
not be built into the app. May only be set on create requests.", |
| 707 "type": "string" |
| 708 }, |
| 709 "deployment": { |
| 710 "$ref": "Deployment", |
| 711 "description": "Code and application artifacts that make up
this version. Only returned in `GET` requests if `view=FULL` is set. May only be
set on create requests; once created, is immutable." |
| 712 } |
| 713 }, |
| 714 "type": "object" |
| 715 }, |
| 716 "AutomaticScaling": { |
| 717 "description": "Automatic scaling is the scaling policy that App Eng
ine has used since its inception. It is based on request rate, response latencie
s, and other application metrics.", |
| 718 "id": "AutomaticScaling", |
| 719 "properties": { |
| 720 "coolDownPeriod": { |
| 721 "description": "The amount of time that the [Autoscaler](htt
ps://cloud.google.com/compute/docs/autoscaler/) should wait between changes to t
he number of virtual machines. Applies only to the VM runtime.", |
| 722 "type": "string" |
| 723 }, |
| 724 "cpuUtilization": { |
| 725 "$ref": "CpuUtilization", |
| 726 "description": "Target scaling by CPU usage." |
| 727 }, |
| 728 "maxConcurrentRequests": { |
| 729 "description": "The number of concurrent requests an automat
ic scaling instance can accept before the scheduler spawns a new instance. Defau
lt value is chosen based on the runtime.", |
| 730 "format": "int32", |
| 731 "type": "integer" |
| 732 }, |
| 733 "maxIdleInstances": { |
| 734 "description": "The maximum number of idle instances that Ap
p Engine should maintain for this version.", |
| 735 "format": "int32", |
| 736 "type": "integer" |
| 737 }, |
| 738 "maxTotalInstances": { |
| 739 "description": "Max number of instances that App Engine shou
ld start to handle requests.", |
| 740 "format": "int32", |
| 741 "type": "integer" |
| 742 }, |
| 743 "maxPendingLatency": { |
| 744 "description": "The maximum amount of time that App Engine s
hould allow a request to wait in the pending queue before starting a new instanc
e to handle it.", |
| 745 "type": "string" |
| 746 }, |
| 747 "minIdleInstances": { |
| 748 "description": "The minimum number of idle instances that Ap
p Engine should maintain for this version. Only applies to the default version o
f a module, since other versions are not expected to receive significant traffic
.", |
| 749 "format": "int32", |
| 750 "type": "integer" |
| 751 }, |
| 752 "minTotalInstances": { |
| 753 "description": "Minimum number of instances that App Engine
should maintain.", |
| 754 "format": "int32", |
| 755 "type": "integer" |
| 756 }, |
| 757 "minPendingLatency": { |
| 758 "description": "The minimum amount of time that App Engine s
hould allow a request to wait in the pending queue before starting a new instanc
e to handle it.", |
| 759 "type": "string" |
| 760 } |
| 761 }, |
| 762 "type": "object" |
| 763 }, |
| 764 "CpuUtilization": { |
| 765 "description": "Target scaling by CPU usage.", |
| 766 "id": "CpuUtilization", |
| 767 "properties": { |
| 768 "aggregationWindowLength": { |
| 769 "description": "The period of time over which CPU utilizatio
n is calculated.", |
| 770 "type": "string" |
| 771 }, |
| 772 "targetUtilization": { |
| 773 "description": "Target (0-1) CPU utilization ratio to mainta
in when scaling.", |
| 774 "format": "double", |
| 775 "type": "number" |
| 776 } |
| 777 }, |
| 778 "type": "object" |
| 779 }, |
| 780 "BasicScaling": { |
| 781 "description": "A module with basic scaling will create an instance
when the application receives a request. The instance will be turned down when t
he app becomes idle. Basic scaling is ideal for work that is intermittent or dri
ven by user activity.", |
| 782 "id": "BasicScaling", |
| 783 "properties": { |
| 784 "idleTimeout": { |
| 785 "description": "The instance will be shut down this amount o
f time after receiving its last request.", |
| 786 "type": "string" |
| 787 }, |
| 788 "maxInstances": { |
| 789 "description": "The maximum number of instances for App Engi
ne to create for this version.", |
| 790 "format": "int32", |
| 791 "type": "integer" |
| 792 } |
| 793 }, |
| 794 "type": "object" |
| 795 }, |
| 796 "ManualScaling": { |
| 797 "description": "A module with manual scaling runs continuously, allo
wing you to perform complex initialization and rely on the state of its memory o
ver time.", |
| 798 "id": "ManualScaling", |
| 799 "properties": { |
| 800 "instances": { |
| 801 "description": "The number of instances to assign to the mod
ule at the start. This number can later be altered by using the [Modules API](ht
tps://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instanc
es()` function.", |
| 802 "format": "int32", |
| 803 "type": "integer" |
| 804 } |
| 805 }, |
| 806 "type": "object" |
| 807 }, |
| 808 "Network": { |
| 809 "description": "Used to specify extra network settings (for VM runti
mes only).", |
| 810 "id": "Network", |
| 811 "properties": { |
| 812 "forwardedPorts": { |
| 813 "description": "A list of ports (or port pairs) to forward f
rom the VM into the app container.", |
| 814 "items": { |
| 815 "type": "string" |
| 816 }, |
| 817 "type": "array" |
| 818 }, |
| 819 "instanceTag": { |
| 820 "description": "A tag to apply to the VM instance during cre
ation.", |
| 821 "type": "string" |
| 822 }, |
| 823 "name": { |
| 824 "description": "The Google Compute Engine network where the
VMs will be created. If not specified, or empty, the network named 'default' wil
l be used. (The short name should be specified, not the resource path.)", |
| 825 "type": "string" |
| 826 } |
| 827 }, |
| 828 "type": "object" |
| 829 }, |
| 830 "Resources": { |
| 831 "description": "Used to specify how many machine resources an app ve
rsion needs.", |
| 832 "id": "Resources", |
| 833 "properties": { |
| 834 "cpu": { |
| 835 "description": "How many CPU cores an app version needs.", |
| 836 "format": "double", |
| 837 "type": "number" |
| 838 }, |
| 839 "diskGb": { |
| 840 "description": "How much disk size, in GB, an app version ne
eds.", |
| 841 "format": "double", |
| 842 "type": "number" |
| 843 }, |
| 844 "memoryGb": { |
| 845 "description": "How much memory, in GB, an app version needs
.", |
| 846 "format": "double", |
| 847 "type": "number" |
| 848 } |
| 849 }, |
| 850 "type": "object" |
| 851 }, |
| 852 "UrlMap": { |
| 853 "description": "A URL pattern and description of how it should be ha
ndled. App Engine can handle URLs by executing application code, or by serving s
tatic files uploaded with the code, such as images, CSS or JavaScript.", |
| 854 "id": "UrlMap", |
| 855 "properties": { |
| 856 "urlRegex": { |
| 857 "description": "A URL prefix. This value uses regular expres
sion syntax (and so regexp special characters must be escaped), but it should no
t contain groupings. All URLs that begin with this prefix are handled by this ha
ndler, using the portion of the URL after the prefix as part of the file path. T
his is always required.", |
| 858 "type": "string" |
| 859 }, |
| 860 "staticFiles": { |
| 861 "$ref": "StaticFilesHandler", |
| 862 "description": "Returns the contents of a file, such as an i
mage, as the response." |
| 863 }, |
| 864 "staticDirectory": { |
| 865 "$ref": "StaticDirectoryHandler", |
| 866 "description": "Serves the entire contents of a directory as
static files. This attribute is deprecated. You can mimic the behavior of stati
c directories using static files." |
| 867 }, |
| 868 "script": { |
| 869 "$ref": "ScriptHandler", |
| 870 "description": "Executes a script to handle the request that
matches the URL pattern." |
| 871 }, |
| 872 "apiEndpoint": { |
| 873 "$ref": "ApiEndpointHandler", |
| 874 "description": "Use API Endpoints to handle requests." |
| 875 }, |
| 876 "securityLevel": { |
| 877 "description": "Configures whether security (HTTPS) should b
e enforced for this URL.", |
| 878 "enum": [ |
| 879 "SECURE_UNSPECIFIED", |
| 880 "SECURE_DEFAULT", |
| 881 "SECURE_NEVER", |
| 882 "SECURE_OPTIONAL", |
| 883 "SECURE_ALWAYS" |
| 884 ], |
| 885 "type": "string" |
| 886 }, |
| 887 "login": { |
| 888 "description": "What level of login is required to access th
is resource.", |
| 889 "enum": [ |
| 890 "LOGIN_UNSPECIFIED", |
| 891 "LOGIN_OPTIONAL", |
| 892 "LOGIN_ADMIN", |
| 893 "LOGIN_REQUIRED" |
| 894 ], |
| 895 "type": "string" |
| 896 }, |
| 897 "authFailAction": { |
| 898 "description": "For users not logged in, how to handle acces
s to resources with required login. Defaults to \"redirect\".", |
| 899 "enum": [ |
| 900 "AUTH_FAIL_ACTION_UNSPECIFIED", |
| 901 "AUTH_FAIL_ACTION_REDIRECT", |
| 902 "AUTH_FAIL_ACTION_UNAUTHORIZED" |
| 903 ], |
| 904 "type": "string" |
| 905 }, |
| 906 "redirectHttpResponseCode": { |
| 907 "description": "`30x` code to use when performing redirects
for the `secure` field. A `302` is used by default.", |
| 908 "enum": [ |
| 909 "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", |
| 910 "REDIRECT_HTTP_RESPONSE_CODE_301", |
| 911 "REDIRECT_HTTP_RESPONSE_CODE_302", |
| 912 "REDIRECT_HTTP_RESPONSE_CODE_303", |
| 913 "REDIRECT_HTTP_RESPONSE_CODE_307" |
| 914 ], |
| 915 "type": "string" |
| 916 } |
| 917 }, |
| 918 "type": "object" |
| 919 }, |
| 920 "StaticFilesHandler": { |
| 921 "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.", |
| 922 "id": "StaticFilesHandler", |
| 923 "properties": { |
| 924 "path": { |
| 925 "description": "The path to the static files matched by the
URL pattern, from the application root directory. The path can refer to text mat
ched in groupings in the URL pattern.", |
| 926 "type": "string" |
| 927 }, |
| 928 "uploadPathRegex": { |
| 929 "description": "A regular expression that matches the file p
aths for all files that will be referenced by this handler.", |
| 930 "type": "string" |
| 931 }, |
| 932 "httpHeaders": { |
| 933 "additionalProperties": { |
| 934 "type": "string" |
| 935 }, |
| 936 "description": "HTTP headers to use for all responses from t
hese URLs.", |
| 937 "type": "object" |
| 938 }, |
| 939 "mimeType": { |
| 940 "description": "If specified, all files served by this handl
er will be served using the specified MIME type. If not specified, the MIME type
for a file will be derived from the file's filename extension.", |
| 941 "type": "string" |
| 942 }, |
| 943 "expiration": { |
| 944 "description": "The length of time a static file served by t
his handler ought to be cached by web proxies and browsers.", |
| 945 "type": "string" |
| 946 }, |
| 947 "requireMatchingFile": { |
| 948 "description": "If true, this [UrlMap][google.appengine.v1be
ta4.UrlMap] entry does not match the request unless the file referenced by the h
andler also exists. If no such file exists, processing will continue with the ne
xt [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL.", |
| 949 "type": "boolean" |
| 950 }, |
| 951 "applicationReadable": { |
| 952 "description": "By default, files declared in static file ha
ndlers are uploaded as static data and are only served to end users, they cannot
be read by an application. If this field is set to true, the files are also upl
oaded as code data so your application can read them. Both uploads are charged a
gainst your code and static data storage resource quotas.", |
| 953 "type": "boolean" |
| 954 } |
| 955 }, |
| 956 "type": "object" |
| 957 }, |
| 958 "StaticDirectoryHandler": { |
| 959 "description": "Files served directly to the user for a given URL, s
uch as images, CSS stylesheets, or JavaScript source files. Static directory han
dlers make it easy to serve the entire contents of a directory as static files."
, |
| 960 "id": "StaticDirectoryHandler", |
| 961 "properties": { |
| 962 "directory": { |
| 963 "description": "The path to the directory containing the sta
tic files, from the application root directory. Everything after the end of the
matched url pattern is appended to static_dir to form the full path to the reque
sted file.", |
| 964 "type": "string" |
| 965 }, |
| 966 "httpHeaders": { |
| 967 "additionalProperties": { |
| 968 "type": "string" |
| 969 }, |
| 970 "description": "HTTP headers to use for all responses from t
hese URLs.", |
| 971 "type": "object" |
| 972 }, |
| 973 "mimeType": { |
| 974 "description": "If specified, all files served by this handl
er will be served using the specified MIME type. If not specified, the MIME type
for a file will be derived from the file's filename extension.", |
| 975 "type": "string" |
| 976 }, |
| 977 "expiration": { |
| 978 "description": "The length of time a static file served by t
his handler ought to be cached by web proxies and browsers.", |
| 979 "type": "string" |
| 980 }, |
| 981 "requireMatchingFile": { |
| 982 "description": "If true, this UrlMap entry does not match th
e request unless the file referenced by the handler also exists. If no such file
exists, processing will continue with the next UrlMap that matches the requeste
d URL.", |
| 983 "type": "boolean" |
| 984 }, |
| 985 "applicationReadable": { |
| 986 "description": "By default, files declared in static file ha
ndlers are uploaded as static data and are only served to end users, they cannot
be read by an application. If this field is set to true, the files are also upl
oaded as code data so your application can read them. Both uploads are charged a
gainst your code and static data storage resource quotas.", |
| 987 "type": "boolean" |
| 988 } |
| 989 }, |
| 990 "type": "object" |
| 991 }, |
| 992 "ScriptHandler": { |
| 993 "description": "Executes a script to handle the request that matches
the URL pattern.", |
| 994 "id": "ScriptHandler", |
| 995 "properties": { |
| 996 "scriptPath": { |
| 997 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 998 "type": "string" |
| 999 } |
| 1000 }, |
| 1001 "type": "object" |
| 1002 }, |
| 1003 "ApiEndpointHandler": { |
| 1004 "description": "Use Google Cloud Endpoints to handle requests.", |
| 1005 "id": "ApiEndpointHandler", |
| 1006 "properties": { |
| 1007 "scriptPath": { |
| 1008 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 1009 "type": "string" |
| 1010 } |
| 1011 }, |
| 1012 "type": "object" |
| 1013 }, |
| 1014 "ErrorHandler": { |
| 1015 "description": "A custom static error page to be served when an erro
r occurs.", |
| 1016 "id": "ErrorHandler", |
| 1017 "properties": { |
| 1018 "errorCode": { |
| 1019 "description": "The error condition this handler applies to.
", |
| 1020 "enum": [ |
| 1021 "ERROR_CODE_UNSPECIFIED", |
| 1022 "ERROR_CODE_DEFAULT", |
| 1023 "ERROR_CODE_OVER_QUOTA", |
| 1024 "ERROR_CODE_DOS_API_DENIAL", |
| 1025 "ERROR_CODE_TIMEOUT" |
| 1026 ], |
| 1027 "type": "string" |
| 1028 }, |
| 1029 "staticFile": { |
| 1030 "description": "Static file content to be served for this er
ror.", |
| 1031 "type": "string" |
| 1032 }, |
| 1033 "mimeType": { |
| 1034 "description": "MIME type of file. If unspecified, \"text/ht
ml\" is assumed.", |
| 1035 "type": "string" |
| 1036 } |
| 1037 }, |
| 1038 "type": "object" |
| 1039 }, |
| 1040 "Library": { |
| 1041 "description": "A Python runtime third-party library required by the
application.", |
| 1042 "id": "Library", |
| 1043 "properties": { |
| 1044 "name": { |
| 1045 "description": "The name of the library, e.g. \"PIL\" or \"d
jango\".", |
| 1046 "type": "string" |
| 1047 }, |
| 1048 "version": { |
| 1049 "description": "The version of the library to select, or \"l
atest\".", |
| 1050 "type": "string" |
| 1051 } |
| 1052 }, |
| 1053 "type": "object" |
| 1054 }, |
| 1055 "ApiConfigHandler": { |
| 1056 "description": "API Serving configuration for Cloud Endpoints.", |
| 1057 "id": "ApiConfigHandler", |
| 1058 "properties": { |
| 1059 "authFailAction": { |
| 1060 "description": "For users not logged in, how to handle acces
s to resources with required login. Defaults to \"redirect\".", |
| 1061 "enum": [ |
| 1062 "AUTH_FAIL_ACTION_UNSPECIFIED", |
| 1063 "AUTH_FAIL_ACTION_REDIRECT", |
| 1064 "AUTH_FAIL_ACTION_UNAUTHORIZED" |
| 1065 ], |
| 1066 "type": "string" |
| 1067 }, |
| 1068 "login": { |
| 1069 "description": "What level of login is required to access th
is resource. Default is \"optional\".", |
| 1070 "enum": [ |
| 1071 "LOGIN_UNSPECIFIED", |
| 1072 "LOGIN_OPTIONAL", |
| 1073 "LOGIN_ADMIN", |
| 1074 "LOGIN_REQUIRED" |
| 1075 ], |
| 1076 "type": "string" |
| 1077 }, |
| 1078 "script": { |
| 1079 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 1080 "type": "string" |
| 1081 }, |
| 1082 "securityLevel": { |
| 1083 "description": "Configures whether security (HTTPS) should b
e enforced for this URL.", |
| 1084 "enum": [ |
| 1085 "SECURE_UNSPECIFIED", |
| 1086 "SECURE_DEFAULT", |
| 1087 "SECURE_NEVER", |
| 1088 "SECURE_OPTIONAL", |
| 1089 "SECURE_ALWAYS" |
| 1090 ], |
| 1091 "type": "string" |
| 1092 }, |
| 1093 "url": { |
| 1094 "description": "URL to serve the endpoint at.", |
| 1095 "type": "string" |
| 1096 } |
| 1097 }, |
| 1098 "type": "object" |
| 1099 }, |
| 1100 "HealthCheck": { |
| 1101 "description": "Configure health checking for the VM instances. Unhe
althy VM instances will be killed and replaced with new instances.", |
| 1102 "id": "HealthCheck", |
| 1103 "properties": { |
| 1104 "disableHealthCheck": { |
| 1105 "description": "Whether to explicitly disable health checks
for this instance.", |
| 1106 "type": "boolean" |
| 1107 }, |
| 1108 "host": { |
| 1109 "description": "The host header to send when performing an H
TTP health check (e.g. myapp.appspot.com)", |
| 1110 "type": "string" |
| 1111 }, |
| 1112 "healthyThreshold": { |
| 1113 "description": "The number of consecutive successful health
checks before receiving traffic.", |
| 1114 "format": "uint32", |
| 1115 "type": "integer" |
| 1116 }, |
| 1117 "unhealthyThreshold": { |
| 1118 "description": "The number of consecutive failed health chec
ks before removing traffic.", |
| 1119 "format": "uint32", |
| 1120 "type": "integer" |
| 1121 }, |
| 1122 "restartThreshold": { |
| 1123 "description": "The number of consecutive failed health chec
ks before an instance is restarted.", |
| 1124 "format": "uint32", |
| 1125 "type": "integer" |
| 1126 }, |
| 1127 "checkInterval": { |
| 1128 "description": "The interval between health checks.", |
| 1129 "type": "string" |
| 1130 }, |
| 1131 "timeout": { |
| 1132 "description": "The amount of time before the health check i
s considered failed.", |
| 1133 "type": "string" |
| 1134 } |
| 1135 }, |
| 1136 "type": "object" |
| 1137 }, |
| 1138 "Deployment": { |
| 1139 "description": "Code and application artifacts used to deploy a vers
ion to App Engine.", |
| 1140 "id": "Deployment", |
| 1141 "properties": { |
| 1142 "files": { |
| 1143 "additionalProperties": { |
| 1144 "$ref": "FileInfo" |
| 1145 }, |
| 1146 "description": "A manifest of files stored in Google Cloud S
torage which should be included as part of this application. All files must be r
eadable using the credentials supplied with this call.", |
| 1147 "type": "object" |
| 1148 }, |
| 1149 "container": { |
| 1150 "$ref": "ContainerInfo", |
| 1151 "description": "If supplied, a docker (container) image whic
h should be used to start the application. Only applicable to the 'vm' runtime." |
| 1152 }, |
| 1153 "sourceReferences": { |
| 1154 "description": "The origin of the source code for this deplo
yment. There can be more than one source reference per Version if source code is
distributed among multiple repositories.", |
| 1155 "items": { |
| 1156 "$ref": "SourceReference" |
| 1157 }, |
| 1158 "type": "array" |
| 1159 } |
| 1160 }, |
| 1161 "type": "object" |
| 1162 }, |
| 1163 "FileInfo": { |
| 1164 "description": "A single source file which is part of the applicatio
n to be deployed.", |
| 1165 "id": "FileInfo", |
| 1166 "properties": { |
| 1167 "sourceUrl": { |
| 1168 "description": "The URL source to use to fetch this file. Mu
st be a URL to a resource in Google Cloud Storage.", |
| 1169 "type": "string" |
| 1170 }, |
| 1171 "sha1Sum": { |
| 1172 "description": "The SHA1 (160 bits) hash of the file in hex.
", |
| 1173 "type": "string" |
| 1174 }, |
| 1175 "mimeType": { |
| 1176 "description": "The MIME type of the file; if unspecified, t
he value from Google Cloud Storage will be used.", |
| 1177 "type": "string" |
| 1178 } |
| 1179 }, |
| 1180 "type": "object" |
| 1181 }, |
| 1182 "ContainerInfo": { |
| 1183 "description": "A Docker (container) image which should be used to s
tart the application.", |
| 1184 "id": "ContainerInfo", |
| 1185 "properties": { |
| 1186 "image": { |
| 1187 "description": "Reference to a hosted container image. Must
be a URI to a resource in a Docker repository. Must be fully qualified, includin
g tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@dig
est", |
| 1188 "type": "string" |
| 1189 }, |
| 1190 "sha256": { |
| 1191 "description": "The SHA256 hash of the image in hex.", |
| 1192 "type": "string" |
| 1193 } |
| 1194 }, |
| 1195 "type": "object" |
| 1196 }, |
| 1197 "SourceReference": { |
| 1198 "description": "A reference to a particular snapshot of the source t
ree used to build and deploy the application.", |
| 1199 "id": "SourceReference", |
| 1200 "properties": { |
| 1201 "repository": { |
| 1202 "description": "Optional. A URI string identifying the repos
itory. Example: \"https://source.developers.google.com/p/app-123/r/default\"", |
| 1203 "type": "string" |
| 1204 }, |
| 1205 "revisionId": { |
| 1206 "description": "The canonical (and persistent) identifier of
the deployed revision, i.e. any kind of aliases including tags or branch names
are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"", |
| 1207 "type": "string" |
| 1208 } |
| 1209 }, |
| 1210 "type": "object" |
| 1211 }, |
| 1212 "Operation": { |
| 1213 "description": "This resource represents a long-running operation th
at is the result of a network API call.", |
| 1214 "id": "Operation", |
| 1215 "properties": { |
| 1216 "name": { |
| 1217 "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 above, the `name` should have the format of `operations/some/unique/n
ame`.", |
| 1218 "type": "string" |
| 1219 }, |
| 1220 "metadata": { |
| 1221 "additionalProperties": { |
| 1222 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 1223 "type": "any" |
| 1224 }, |
| 1225 "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.", |
| 1226 "type": "object" |
| 1227 }, |
| 1228 "done": { |
| 1229 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed and the `result` i
s available.", |
| 1230 "type": "boolean" |
| 1231 }, |
| 1232 "error": { |
| 1233 "$ref": "Status", |
| 1234 "description": "The error result of the operation in case of
failure." |
| 1235 }, |
| 1236 "response": { |
| 1237 "additionalProperties": { |
| 1238 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 1239 "type": "any" |
| 1240 }, |
| 1241 "description": "The normal response of the operation in case
of success. If the original method returns no data on success, such as `Delete`
, the response is `google.protobuf.Empty`. If the original method is standard `G
et`/`Create`/`Update`, the response should be the resource. For other methods, t
he response should have the type `XxxResponse`, where `Xxx` is the original meth
od name. For example, if the original method name is `TakeSnapshot()`, the infer
red response type is `TakeSnapshotResponse`.", |
| 1242 "type": "object" |
| 1243 } |
| 1244 }, |
| 1245 "type": "object" |
| 1246 }, |
| 1247 "Status": { |
| 1248 "description": "The `Status` defines a logical error model that is s
uitable for different programming environments, including REST APIs and RPC APIs
. It is used by [gRPC](https://github.com/grpc). The error model is designed to
be: - Simple to use and understand for most users. - Flexible enough to meet une
xpected needs. # Overview The `Status` message contains 3 pieces of data: error
code, error message, and error details. The error code should be an enum value o
f [google.rpc.Code][google.rpc.Code], but it may accept additional error codes i
f needed. The error message should be a developer-facing English message that he
lps developers *understand* and *resolve* the error. If a localized user-facing
error message is needed, it can be sent in the error details or localized by the
client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.rp
c` which can be used for common error conditions. # Language mapping The `Status
` message is the logical representation of the error model, but it is not necess
arily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. For
example, it will likely be mapped to some exceptions in Java, but more likely m
apped to some error codes in C. # Other uses The error model and the `Status` me
ssage can be used in a variety of environments - either with or without APIs - t
o provide consistent developer experience across different environments. Example
uses of this error model include: - Partial errors. If a service needs to retur
n partial errors to the client, it may embed the `Status` in the normal response
to indicate the partial errors. - Workflow errors. A typical workflow has multi
ple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Status
` message should be used directly inside batch response, one for each error sub-
response. - Asynchronous operations. If an API call embeds asynchronous operatio
n results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored in
logs, the message `Status` could be used directly after any stripping needed fo
r security/privacy reasons.", |
| 1249 "id": "Status", |
| 1250 "properties": { |
| 1251 "code": { |
| 1252 "description": "The status code, which should be an enum val
ue of [google.rpc.Code][google.rpc.Code].", |
| 1253 "format": "int32", |
| 1254 "type": "integer" |
| 1255 }, |
| 1256 "message": { |
| 1257 "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][google.rpc.Status.details] field, or localized b
y the client.", |
| 1258 "type": "string" |
| 1259 }, |
| 1260 "details": { |
| 1261 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", |
| 1262 "items": { |
| 1263 "additionalProperties": { |
| 1264 "description": "Properties of the object. Contains f
ield @ype with type URL.", |
| 1265 "type": "any" |
| 1266 }, |
| 1267 "type": "object" |
| 1268 }, |
| 1269 "type": "array" |
| 1270 } |
| 1271 }, |
| 1272 "type": "object" |
| 1273 }, |
| 1274 "ListVersionsResponse": { |
| 1275 "description": "Response message for `Versions.ListVersions`.", |
| 1276 "id": "ListVersionsResponse", |
| 1277 "properties": { |
| 1278 "versions": { |
| 1279 "description": "The versions belonging to the requested appl
ication module.", |
| 1280 "items": { |
| 1281 "$ref": "Version" |
| 1282 }, |
| 1283 "type": "array" |
| 1284 }, |
| 1285 "nextPageToken": { |
| 1286 "description": "Continuation token for fetching the next pag
e of results.", |
| 1287 "type": "string" |
| 1288 } |
| 1289 }, |
| 1290 "type": "object" |
| 1291 }, |
| 1292 "Module": { |
| 1293 "description": "A module is a component of an application that provi
des a single service or configuration. A module has a collection of versions tha
t define a specific set of code used to implement the functionality of that modu
le.", |
| 1294 "id": "Module", |
| 1295 "properties": { |
| 1296 "name": { |
| 1297 "description": "The full path to the Module resource in the
API. Example: \"apps/myapp/modules/default\" @OutputOnly", |
| 1298 "type": "string" |
| 1299 }, |
| 1300 "id": { |
| 1301 "description": "The relative name/path of the module within
the application. Example: \"default\" @OutputOnly", |
| 1302 "type": "string" |
| 1303 }, |
| 1304 "split": { |
| 1305 "$ref": "TrafficSplit", |
| 1306 "description": "A mapping that defines fractional HTTP traff
ic diversion to different versions within the module." |
| 1307 } |
| 1308 }, |
| 1309 "type": "object" |
| 1310 }, |
| 1311 "TrafficSplit": { |
| 1312 "description": "Configuration for traffic splitting for versions wit
hin a single module. Traffic splitting allows traffic directed to the module to
be assigned to one of several versions in a fractional way, enabling experiments
and canarying new builds, for example.", |
| 1313 "id": "TrafficSplit", |
| 1314 "properties": { |
| 1315 "shardBy": { |
| 1316 "description": "Which mechanism should be used as a selector
when choosing a version to send a request to. The traffic selection algorithm w
ill be stable for either type until allocations are changed.", |
| 1317 "enum": [ |
| 1318 "UNSPECIFIED", |
| 1319 "COOKIE", |
| 1320 "IP" |
| 1321 ], |
| 1322 "type": "string" |
| 1323 }, |
| 1324 "allocations": { |
| 1325 "additionalProperties": { |
| 1326 "format": "double", |
| 1327 "type": "number" |
| 1328 }, |
| 1329 "description": "Mapping from module version IDs within the m
odule to fractional (0.000, 1] allocations of traffic for that version. Each ver
sion may only be specified once, but some versions in the module may not have an
y traffic allocation. Modules that have traffic allocated in this field may not
be deleted until the module is deleted, or their traffic allocation is removed.
Allocations must sum to 1. Supports precision up to two decimal places for IP-ba
sed splits and up to three decimal places for cookie-based splits.", |
| 1330 "type": "object" |
| 1331 } |
| 1332 }, |
| 1333 "type": "object" |
| 1334 }, |
| 1335 "ListModulesResponse": { |
| 1336 "description": "Response message for `Modules.ListModules`.", |
| 1337 "id": "ListModulesResponse", |
| 1338 "properties": { |
| 1339 "modules": { |
| 1340 "description": "The modules belonging to the requested appli
cation.", |
| 1341 "items": { |
| 1342 "$ref": "Module" |
| 1343 }, |
| 1344 "type": "array" |
| 1345 }, |
| 1346 "nextPageToken": { |
| 1347 "description": "Continuation token for fetching the next pag
e of results.", |
| 1348 "type": "string" |
| 1349 } |
| 1350 }, |
| 1351 "type": "object" |
| 1352 }, |
| 1353 "ListOperationsResponse": { |
| 1354 "description": "The response message for [Operations.ListOperations]
[google.longrunning.Operations.ListOperations].", |
| 1355 "id": "ListOperationsResponse", |
| 1356 "properties": { |
| 1357 "operations": { |
| 1358 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 1359 "items": { |
| 1360 "$ref": "Operation" |
| 1361 }, |
| 1362 "type": "array" |
| 1363 }, |
| 1364 "nextPageToken": { |
| 1365 "description": "The standard List next-page token.", |
| 1366 "type": "string" |
| 1367 } |
| 1368 }, |
| 1369 "type": "object" |
| 1370 }, |
| 1371 "OperationMetadata": { |
| 1372 "description": "Metadata for the given [google.longrunning.Operation
][google.longrunning.Operation].", |
| 1373 "id": "OperationMetadata", |
| 1374 "properties": { |
| 1375 "operationType": { |
| 1376 "description": "The type of the operation, e.g. 'deployment'
. @OutputOnly", |
| 1377 "type": "string" |
| 1378 }, |
| 1379 "insertTime": { |
| 1380 "description": "Timestamp that this operation was received.
@OutputOnly", |
| 1381 "type": "string" |
| 1382 }, |
| 1383 "endTime": { |
| 1384 "description": "Timestamp that this operation was completed.
(Not present if the operation is still in progress.) @OutputOnly", |
| 1385 "type": "string" |
| 1386 }, |
| 1387 "user": { |
| 1388 "description": "The user who requested this operation. @Outp
utOnly", |
| 1389 "type": "string" |
| 1390 } |
| 1391 }, |
| 1392 "type": "object" |
| 1393 }, |
| 1394 "Type": { |
| 1395 "description": "A light-weight descriptor for a proto message type."
, |
| 1396 "id": "Type", |
| 1397 "properties": { |
| 1398 "name": { |
| 1399 "description": "The fully qualified message name.", |
| 1400 "type": "string" |
| 1401 }, |
| 1402 "fields": { |
| 1403 "description": "The list of fields.", |
| 1404 "items": { |
| 1405 "$ref": "Field" |
| 1406 }, |
| 1407 "type": "array" |
| 1408 }, |
| 1409 "oneofs": { |
| 1410 "description": "The list of oneof definitions. The list of o
neofs declared in this Type", |
| 1411 "items": { |
| 1412 "type": "string" |
| 1413 }, |
| 1414 "type": "array" |
| 1415 }, |
| 1416 "options": { |
| 1417 "description": "The proto options.", |
| 1418 "items": { |
| 1419 "$ref": "Option" |
| 1420 }, |
| 1421 "type": "array" |
| 1422 }, |
| 1423 "sourceContext": { |
| 1424 "$ref": "SourceContext", |
| 1425 "description": "The source context." |
| 1426 }, |
| 1427 "syntax": { |
| 1428 "description": "The source syntax.", |
| 1429 "enum": [ |
| 1430 "SYNTAX_PROTO2", |
| 1431 "SYNTAX_PROTO3" |
| 1432 ], |
| 1433 "type": "string" |
| 1434 } |
| 1435 }, |
| 1436 "type": "object" |
| 1437 }, |
| 1438 "Field": { |
| 1439 "description": "Field represents a single field of a message type.", |
| 1440 "id": "Field", |
| 1441 "properties": { |
| 1442 "kind": { |
| 1443 "description": "The field kind.", |
| 1444 "enum": [ |
| 1445 "TYPE_UNKNOWN", |
| 1446 "TYPE_DOUBLE", |
| 1447 "TYPE_FLOAT", |
| 1448 "TYPE_INT64", |
| 1449 "TYPE_UINT64", |
| 1450 "TYPE_INT32", |
| 1451 "TYPE_FIXED64", |
| 1452 "TYPE_FIXED32", |
| 1453 "TYPE_BOOL", |
| 1454 "TYPE_STRING", |
| 1455 "TYPE_GROUP", |
| 1456 "TYPE_MESSAGE", |
| 1457 "TYPE_BYTES", |
| 1458 "TYPE_UINT32", |
| 1459 "TYPE_ENUM", |
| 1460 "TYPE_SFIXED32", |
| 1461 "TYPE_SFIXED64", |
| 1462 "TYPE_SINT32", |
| 1463 "TYPE_SINT64" |
| 1464 ], |
| 1465 "type": "string" |
| 1466 }, |
| 1467 "cardinality": { |
| 1468 "description": "The field cardinality, i.e. optional/require
d/repeated.", |
| 1469 "enum": [ |
| 1470 "CARDINALITY_UNKNOWN", |
| 1471 "CARDINALITY_OPTIONAL", |
| 1472 "CARDINALITY_REQUIRED", |
| 1473 "CARDINALITY_REPEATED" |
| 1474 ], |
| 1475 "type": "string" |
| 1476 }, |
| 1477 "number": { |
| 1478 "description": "The proto field number.", |
| 1479 "format": "int32", |
| 1480 "type": "integer" |
| 1481 }, |
| 1482 "name": { |
| 1483 "description": "The field name.", |
| 1484 "type": "string" |
| 1485 }, |
| 1486 "typeUrl": { |
| 1487 "description": "The type URL (without the scheme) when the t
ype is MESSAGE or ENUM, such as `type.googleapis.com/google.protobuf.Empty`.", |
| 1488 "type": "string" |
| 1489 }, |
| 1490 "oneofIndex": { |
| 1491 "description": "Index in Type.oneofs. Starts at 1. Zero mean
s no oneof mapping.", |
| 1492 "format": "int32", |
| 1493 "type": "integer" |
| 1494 }, |
| 1495 "packed": { |
| 1496 "description": "Whether to use alternative packed wire repre
sentation.", |
| 1497 "type": "boolean" |
| 1498 }, |
| 1499 "options": { |
| 1500 "description": "The proto options.", |
| 1501 "items": { |
| 1502 "$ref": "Option" |
| 1503 }, |
| 1504 "type": "array" |
| 1505 }, |
| 1506 "jsonName": { |
| 1507 "description": "The JSON name for this field.", |
| 1508 "type": "string" |
| 1509 } |
| 1510 }, |
| 1511 "type": "object" |
| 1512 }, |
| 1513 "Option": { |
| 1514 "description": "Proto option attached to messages/fields/enums etc."
, |
| 1515 "id": "Option", |
| 1516 "properties": { |
| 1517 "name": { |
| 1518 "description": "Proto option name.", |
| 1519 "type": "string" |
| 1520 }, |
| 1521 "value": { |
| 1522 "additionalProperties": { |
| 1523 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 1524 "type": "any" |
| 1525 }, |
| 1526 "description": "Proto option value.", |
| 1527 "type": "object" |
| 1528 } |
| 1529 }, |
| 1530 "type": "object" |
| 1531 }, |
| 1532 "SourceContext": { |
| 1533 "description": "`SourceContext` represents information about the sou
rce of a protobuf element, like the file in which it is defined.", |
| 1534 "id": "SourceContext", |
| 1535 "properties": { |
| 1536 "fileName": { |
| 1537 "description": "The path-qualified name of the .proto file t
hat contained the associated protobuf element. For example: `\"google/protobuf/s
ource.proto\"`.", |
| 1538 "type": "string" |
| 1539 } |
| 1540 }, |
| 1541 "type": "object" |
| 1542 } |
| 1543 }, |
| 1544 "servicePath": "", |
| 1545 "title": "Google App Engine Admin API", |
| 1546 "version": "v1beta4" |
| 1547 } |
OLD | NEW |