| 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 Google App Engine Admin API enables developers to provis
ion and manage their App Engine applications.", |
| 15 "discoveryVersion": "v1", |
| 16 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", |
| 17 "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tL7xNjyj_kg_Ll9deL7DxZKPLUI\"", |
| 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:v1beta5", |
| 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 could
not be created, the request will fail with an error code. Additionally, this pa
rameter can cause the request to take longer to complete. Note: This parameter w
ill be deprecated in a future version of the API.", |
| 126 "location": "query", |
| 127 "type": "boolean" |
| 128 } |
| 129 }, |
| 130 "path": "v1beta5/apps/{appsId}", |
| 131 "response": { |
| 132 "$ref": "Application" |
| 133 }, |
| 134 "scopes": [ |
| 135 "https://www.googleapis.com/auth/cloud-platform" |
| 136 ] |
| 137 } |
| 138 }, |
| 139 "resources": { |
| 140 "operations": { |
| 141 "methods": { |
| 142 "get": { |
| 143 "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.", |
| 144 "httpMethod": "GET", |
| 145 "id": "appengine.apps.operations.get", |
| 146 "parameterOrder": [ |
| 147 "appsId", |
| 148 "operationsId" |
| 149 ], |
| 150 "parameters": { |
| 151 "appsId": { |
| 152 "description": "Part of `name`. The name of
the operation resource.", |
| 153 "location": "path", |
| 154 "required": true, |
| 155 "type": "string" |
| 156 }, |
| 157 "operationsId": { |
| 158 "description": "Part of `name`. See document
ation of `appsId`.", |
| 159 "location": "path", |
| 160 "required": true, |
| 161 "type": "string" |
| 162 } |
| 163 }, |
| 164 "path": "v1beta5/apps/{appsId}/operations/{operation
sId}", |
| 165 "response": { |
| 166 "$ref": "Operation" |
| 167 }, |
| 168 "scopes": [ |
| 169 "https://www.googleapis.com/auth/cloud-platform" |
| 170 ] |
| 171 }, |
| 172 "list": { |
| 173 "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`.", |
| 174 "httpMethod": "GET", |
| 175 "id": "appengine.apps.operations.list", |
| 176 "parameterOrder": [ |
| 177 "appsId" |
| 178 ], |
| 179 "parameters": { |
| 180 "appsId": { |
| 181 "description": "Part of `name`. The name of
the operation collection.", |
| 182 "location": "path", |
| 183 "required": true, |
| 184 "type": "string" |
| 185 }, |
| 186 "filter": { |
| 187 "description": "The standard list filter.", |
| 188 "location": "query", |
| 189 "type": "string" |
| 190 }, |
| 191 "pageSize": { |
| 192 "description": "The standard list page size.
", |
| 193 "format": "int32", |
| 194 "location": "query", |
| 195 "type": "integer" |
| 196 }, |
| 197 "pageToken": { |
| 198 "description": "The standard list page token
.", |
| 199 "location": "query", |
| 200 "type": "string" |
| 201 } |
| 202 }, |
| 203 "path": "v1beta5/apps/{appsId}/operations", |
| 204 "response": { |
| 205 "$ref": "ListOperationsResponse" |
| 206 }, |
| 207 "scopes": [ |
| 208 "https://www.googleapis.com/auth/cloud-platform" |
| 209 ] |
| 210 } |
| 211 } |
| 212 }, |
| 213 "services": { |
| 214 "methods": { |
| 215 "delete": { |
| 216 "description": "Deletes a service and all enclosed v
ersions.", |
| 217 "httpMethod": "DELETE", |
| 218 "id": "appengine.apps.services.delete", |
| 219 "parameterOrder": [ |
| 220 "appsId", |
| 221 "servicesId" |
| 222 ], |
| 223 "parameters": { |
| 224 "appsId": { |
| 225 "description": "Part of `name`. Name of the
resource requested. For example: \"apps/myapp/services/default\".", |
| 226 "location": "path", |
| 227 "required": true, |
| 228 "type": "string" |
| 229 }, |
| 230 "servicesId": { |
| 231 "description": "Part of `name`. See document
ation of `appsId`.", |
| 232 "location": "path", |
| 233 "required": true, |
| 234 "type": "string" |
| 235 } |
| 236 }, |
| 237 "path": "v1beta5/apps/{appsId}/services/{servicesId}
", |
| 238 "response": { |
| 239 "$ref": "Operation" |
| 240 }, |
| 241 "scopes": [ |
| 242 "https://www.googleapis.com/auth/cloud-platform" |
| 243 ] |
| 244 }, |
| 245 "get": { |
| 246 "description": "Gets the current configuration of th
e service.", |
| 247 "httpMethod": "GET", |
| 248 "id": "appengine.apps.services.get", |
| 249 "parameterOrder": [ |
| 250 "appsId", |
| 251 "servicesId" |
| 252 ], |
| 253 "parameters": { |
| 254 "appsId": { |
| 255 "description": "Part of `name`. Name of the
resource requested. For example: \"apps/myapp/services/default\".", |
| 256 "location": "path", |
| 257 "required": true, |
| 258 "type": "string" |
| 259 }, |
| 260 "servicesId": { |
| 261 "description": "Part of `name`. See document
ation of `appsId`.", |
| 262 "location": "path", |
| 263 "required": true, |
| 264 "type": "string" |
| 265 } |
| 266 }, |
| 267 "path": "v1beta5/apps/{appsId}/services/{servicesId}
", |
| 268 "response": { |
| 269 "$ref": "Service" |
| 270 }, |
| 271 "scopes": [ |
| 272 "https://www.googleapis.com/auth/cloud-platform" |
| 273 ] |
| 274 }, |
| 275 "list": { |
| 276 "description": "Lists all the services in the applic
ation.", |
| 277 "httpMethod": "GET", |
| 278 "id": "appengine.apps.services.list", |
| 279 "parameterOrder": [ |
| 280 "appsId" |
| 281 ], |
| 282 "parameters": { |
| 283 "appsId": { |
| 284 "description": "Part of `name`. Name of the
resource requested. For example: \"apps/myapp\".", |
| 285 "location": "path", |
| 286 "required": true, |
| 287 "type": "string" |
| 288 }, |
| 289 "pageSize": { |
| 290 "description": "Maximum results to return pe
r page.", |
| 291 "format": "int32", |
| 292 "location": "query", |
| 293 "type": "integer" |
| 294 }, |
| 295 "pageToken": { |
| 296 "description": "Continuation token for fetch
ing the next page of results.", |
| 297 "location": "query", |
| 298 "type": "string" |
| 299 } |
| 300 }, |
| 301 "path": "v1beta5/apps/{appsId}/services", |
| 302 "response": { |
| 303 "$ref": "ListServicesResponse" |
| 304 }, |
| 305 "scopes": [ |
| 306 "https://www.googleapis.com/auth/cloud-platform" |
| 307 ] |
| 308 }, |
| 309 "patch": { |
| 310 "description": "Updates the configuration of the spe
cified service.", |
| 311 "httpMethod": "PATCH", |
| 312 "id": "appengine.apps.services.patch", |
| 313 "parameterOrder": [ |
| 314 "appsId", |
| 315 "servicesId" |
| 316 ], |
| 317 "parameters": { |
| 318 "appsId": { |
| 319 "description": "Part of `name`. Name of the
resource to update. For example: \"apps/myapp/services/default\".", |
| 320 "location": "path", |
| 321 "required": true, |
| 322 "type": "string" |
| 323 }, |
| 324 "servicesId": { |
| 325 "description": "Part of `name`. See document
ation of `appsId`.", |
| 326 "location": "path", |
| 327 "required": true, |
| 328 "type": "string" |
| 329 }, |
| 330 "mask": { |
| 331 "description": "Standard field mask for the
set of fields to be updated.", |
| 332 "location": "query", |
| 333 "type": "string" |
| 334 }, |
| 335 "migrateTraffic": { |
| 336 "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.", |
| 337 "location": "query", |
| 338 "type": "boolean" |
| 339 } |
| 340 }, |
| 341 "path": "v1beta5/apps/{appsId}/services/{servicesId}
", |
| 342 "request": { |
| 343 "$ref": "Service" |
| 344 }, |
| 345 "response": { |
| 346 "$ref": "Operation" |
| 347 }, |
| 348 "scopes": [ |
| 349 "https://www.googleapis.com/auth/cloud-platform" |
| 350 ] |
| 351 } |
| 352 }, |
| 353 "resources": { |
| 354 "versions": { |
| 355 "methods": { |
| 356 "create": { |
| 357 "description": "Deploys new code and resourc
e files to a version.", |
| 358 "httpMethod": "POST", |
| 359 "id": "appengine.apps.services.versions.crea
te", |
| 360 "parameterOrder": [ |
| 361 "appsId", |
| 362 "servicesId" |
| 363 ], |
| 364 "parameters": { |
| 365 "appsId": { |
| 366 "description": "Part of `name`. Name
of the resource to update. For example: \"apps/myapp/services/default\".", |
| 367 "location": "path", |
| 368 "required": true, |
| 369 "type": "string" |
| 370 }, |
| 371 "servicesId": { |
| 372 "description": "Part of `name`. See
documentation of `appsId`.", |
| 373 "location": "path", |
| 374 "required": true, |
| 375 "type": "string" |
| 376 } |
| 377 }, |
| 378 "path": "v1beta5/apps/{appsId}/services/{ser
vicesId}/versions", |
| 379 "request": { |
| 380 "$ref": "Version" |
| 381 }, |
| 382 "response": { |
| 383 "$ref": "Operation" |
| 384 }, |
| 385 "scopes": [ |
| 386 "https://www.googleapis.com/auth/cloud-p
latform" |
| 387 ] |
| 388 }, |
| 389 "delete": { |
| 390 "description": "Deletes an existing version.
", |
| 391 "httpMethod": "DELETE", |
| 392 "id": "appengine.apps.services.versions.dele
te", |
| 393 "parameterOrder": [ |
| 394 "appsId", |
| 395 "servicesId", |
| 396 "versionsId" |
| 397 ], |
| 398 "parameters": { |
| 399 "appsId": { |
| 400 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/services/default/versions/
v1\".", |
| 401 "location": "path", |
| 402 "required": true, |
| 403 "type": "string" |
| 404 }, |
| 405 "servicesId": { |
| 406 "description": "Part of `name`. See
documentation of `appsId`.", |
| 407 "location": "path", |
| 408 "required": true, |
| 409 "type": "string" |
| 410 }, |
| 411 "versionsId": { |
| 412 "description": "Part of `name`. See
documentation of `appsId`.", |
| 413 "location": "path", |
| 414 "required": true, |
| 415 "type": "string" |
| 416 } |
| 417 }, |
| 418 "path": "v1beta5/apps/{appsId}/services/{ser
vicesId}/versions/{versionsId}", |
| 419 "response": { |
| 420 "$ref": "Operation" |
| 421 }, |
| 422 "scopes": [ |
| 423 "https://www.googleapis.com/auth/cloud-p
latform" |
| 424 ] |
| 425 }, |
| 426 "get": { |
| 427 "description": "Gets application deployment
information.", |
| 428 "httpMethod": "GET", |
| 429 "id": "appengine.apps.services.versions.get"
, |
| 430 "parameterOrder": [ |
| 431 "appsId", |
| 432 "servicesId", |
| 433 "versionsId" |
| 434 ], |
| 435 "parameters": { |
| 436 "appsId": { |
| 437 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/services/default/versions/
v1\".", |
| 438 "location": "path", |
| 439 "required": true, |
| 440 "type": "string" |
| 441 }, |
| 442 "servicesId": { |
| 443 "description": "Part of `name`. See
documentation of `appsId`.", |
| 444 "location": "path", |
| 445 "required": true, |
| 446 "type": "string" |
| 447 }, |
| 448 "versionsId": { |
| 449 "description": "Part of `name`. See
documentation of `appsId`.", |
| 450 "location": "path", |
| 451 "required": true, |
| 452 "type": "string" |
| 453 }, |
| 454 "view": { |
| 455 "description": "Controls the set of
fields returned in the `Get` response.", |
| 456 "enum": [ |
| 457 "BASIC", |
| 458 "FULL" |
| 459 ], |
| 460 "location": "query", |
| 461 "type": "string" |
| 462 } |
| 463 }, |
| 464 "path": "v1beta5/apps/{appsId}/services/{ser
vicesId}/versions/{versionsId}", |
| 465 "response": { |
| 466 "$ref": "Version" |
| 467 }, |
| 468 "scopes": [ |
| 469 "https://www.googleapis.com/auth/cloud-p
latform" |
| 470 ] |
| 471 }, |
| 472 "list": { |
| 473 "description": "Lists the versions of a serv
ice.", |
| 474 "httpMethod": "GET", |
| 475 "id": "appengine.apps.services.versions.list
", |
| 476 "parameterOrder": [ |
| 477 "appsId", |
| 478 "servicesId" |
| 479 ], |
| 480 "parameters": { |
| 481 "appsId": { |
| 482 "description": "Part of `name`. Name
of the resource requested. For example: \"apps/myapp/services/default\".", |
| 483 "location": "path", |
| 484 "required": true, |
| 485 "type": "string" |
| 486 }, |
| 487 "servicesId": { |
| 488 "description": "Part of `name`. See
documentation of `appsId`.", |
| 489 "location": "path", |
| 490 "required": true, |
| 491 "type": "string" |
| 492 }, |
| 493 "view": { |
| 494 "description": "Controls the set of
fields returned in the `List` response.", |
| 495 "enum": [ |
| 496 "BASIC", |
| 497 "FULL" |
| 498 ], |
| 499 "location": "query", |
| 500 "type": "string" |
| 501 }, |
| 502 "pageSize": { |
| 503 "description": "Maximum results to r
eturn per page.", |
| 504 "format": "int32", |
| 505 "location": "query", |
| 506 "type": "integer" |
| 507 }, |
| 508 "pageToken": { |
| 509 "description": "Continuation token f
or fetching the next page of results.", |
| 510 "location": "query", |
| 511 "type": "string" |
| 512 } |
| 513 }, |
| 514 "path": "v1beta5/apps/{appsId}/services/{ser
vicesId}/versions", |
| 515 "response": { |
| 516 "$ref": "ListVersionsResponse" |
| 517 }, |
| 518 "scopes": [ |
| 519 "https://www.googleapis.com/auth/cloud-p
latform" |
| 520 ] |
| 521 }, |
| 522 "patch": { |
| 523 "description": "Updates an existing version.
Note: UNIMPLEMENTED.", |
| 524 "httpMethod": "PATCH", |
| 525 "id": "appengine.apps.services.versions.patc
h", |
| 526 "parameterOrder": [ |
| 527 "appsId", |
| 528 "servicesId", |
| 529 "versionsId" |
| 530 ], |
| 531 "parameters": { |
| 532 "appsId": { |
| 533 "description": "Part of `name`. Name
of the resource to update. For example: \"apps/myapp/services/default/versions/
1\".", |
| 534 "location": "path", |
| 535 "required": true, |
| 536 "type": "string" |
| 537 }, |
| 538 "servicesId": { |
| 539 "description": "Part of `name`. See
documentation of `appsId`.", |
| 540 "location": "path", |
| 541 "required": true, |
| 542 "type": "string" |
| 543 }, |
| 544 "versionsId": { |
| 545 "description": "Part of `name`. See
documentation of `appsId`.", |
| 546 "location": "path", |
| 547 "required": true, |
| 548 "type": "string" |
| 549 }, |
| 550 "mask": { |
| 551 "description": "Standard field mask
for the set of fields to be updated.", |
| 552 "location": "query", |
| 553 "type": "string" |
| 554 } |
| 555 }, |
| 556 "path": "v1beta5/apps/{appsId}/services/{ser
vicesId}/versions/{versionsId}", |
| 557 "request": { |
| 558 "$ref": "Version" |
| 559 }, |
| 560 "response": { |
| 561 "$ref": "Version" |
| 562 }, |
| 563 "scopes": [ |
| 564 "https://www.googleapis.com/auth/cloud-p
latform" |
| 565 ] |
| 566 } |
| 567 } |
| 568 } |
| 569 } |
| 570 } |
| 571 } |
| 572 } |
| 573 }, |
| 574 "revision": "20160223", |
| 575 "rootUrl": "https://appengine.googleapis.com/", |
| 576 "schemas": { |
| 577 "Operation": { |
| 578 "description": "This resource represents a long-running operation th
at is the result of a network API call.", |
| 579 "id": "Operation", |
| 580 "properties": { |
| 581 "name": { |
| 582 "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`.", |
| 583 "type": "string" |
| 584 }, |
| 585 "metadata": { |
| 586 "additionalProperties": { |
| 587 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 588 "type": "any" |
| 589 }, |
| 590 "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.", |
| 591 "type": "object" |
| 592 }, |
| 593 "done": { |
| 594 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed, and either `error
` or `response` is available.", |
| 595 "type": "boolean" |
| 596 }, |
| 597 "error": { |
| 598 "$ref": "Status", |
| 599 "description": "The error result of the operation in case of
failure." |
| 600 }, |
| 601 "response": { |
| 602 "additionalProperties": { |
| 603 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 604 "type": "any" |
| 605 }, |
| 606 "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`.", |
| 607 "type": "object" |
| 608 } |
| 609 }, |
| 610 "type": "object" |
| 611 }, |
| 612 "Status": { |
| 613 "description": "The `Status` type defines a logical error model that
is suitable for different programming environments, including REST APIs and RPC
APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of google.rpc.Code, but it may accept additional error codes if needed. Th
e error message should be a developer-facing English message that helps develope
rs *understand* and *resolve* the error. If a localized user-facing error messag
e is needed, put the localized message in the error details or localize it in th
e client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.r
pc` which can be used for common error conditions. # Language mapping The `Statu
s` message is the logical representation of the error model, but it is not neces
sarily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. Fo
r example, it will likely be mapped to some exceptions in Java, but more likely
mapped to some error codes in C. # Other uses The error model and the `Status` m
essage can be used in a variety of environments, either with or without APIs, to
provide a consistent developer experience across different environments. Exampl
e uses of this error model include: - Partial errors. If a service needs to retu
rn partial errors to the client, it may embed the `Status` in the normal respons
e to indicate the partial errors. - Workflow errors. A typical workflow has mult
iple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Statu
s` message should be used directly inside batch response, one for each error sub
-response. - Asynchronous operations. If an API call embeds asynchronous operati
on results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored i
n logs, the message `Status` could be used directly after any stripping needed f
or security/privacy reasons.", |
| 614 "id": "Status", |
| 615 "properties": { |
| 616 "code": { |
| 617 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 618 "format": "int32", |
| 619 "type": "integer" |
| 620 }, |
| 621 "message": { |
| 622 "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.", |
| 623 "type": "string" |
| 624 }, |
| 625 "details": { |
| 626 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", |
| 627 "items": { |
| 628 "additionalProperties": { |
| 629 "description": "Properties of the object. Contains f
ield @ype with type URL.", |
| 630 "type": "any" |
| 631 }, |
| 632 "type": "object" |
| 633 }, |
| 634 "type": "array" |
| 635 } |
| 636 }, |
| 637 "type": "object" |
| 638 }, |
| 639 "ListOperationsResponse": { |
| 640 "description": "The response message for Operations.ListOperations."
, |
| 641 "id": "ListOperationsResponse", |
| 642 "properties": { |
| 643 "operations": { |
| 644 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 645 "items": { |
| 646 "$ref": "Operation" |
| 647 }, |
| 648 "type": "array" |
| 649 }, |
| 650 "nextPageToken": { |
| 651 "description": "The standard List next-page token.", |
| 652 "type": "string" |
| 653 } |
| 654 }, |
| 655 "type": "object" |
| 656 }, |
| 657 "Application": { |
| 658 "description": "An Application contains the top-level configuration
of an App Engine application.", |
| 659 "id": "Application", |
| 660 "properties": { |
| 661 "name": { |
| 662 "description": "The full path to the application in the API.
Example: \"apps/myapp\". @OutputOnly", |
| 663 "type": "string" |
| 664 }, |
| 665 "id": { |
| 666 "description": "The relative name/path of the application. E
xample: \"myapp\".", |
| 667 "type": "string" |
| 668 }, |
| 669 "dispatchRules": { |
| 670 "description": "HTTP path dispatch rules for requests to the
app that do not explicitly target a service or version. The rules are order-dep
endent.", |
| 671 "items": { |
| 672 "$ref": "UrlDispatchRule" |
| 673 }, |
| 674 "type": "array" |
| 675 }, |
| 676 "authDomain": { |
| 677 "description": "If set, only users from the specified Google
Apps authentication domain may access the application. If not set, any Google A
ccount may access the application.", |
| 678 "type": "string" |
| 679 }, |
| 680 "location": { |
| 681 "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\".", |
| 682 "type": "string" |
| 683 }, |
| 684 "codeBucket": { |
| 685 "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", |
| 686 "type": "string" |
| 687 }, |
| 688 "defaultCookieExpiration": { |
| 689 "description": "Determines the cookie expiration policy for
the application.", |
| 690 "type": "string" |
| 691 }, |
| 692 "defaultHostname": { |
| 693 "description": "The hostname used to reach the application,
as resolved by App Engine. @OutputOnly", |
| 694 "type": "string" |
| 695 }, |
| 696 "defaultBucket": { |
| 697 "description": "A Google Cloud Storage bucket which can be u
sed by the application to store content. @OutputOnly", |
| 698 "type": "string" |
| 699 } |
| 700 }, |
| 701 "type": "object" |
| 702 }, |
| 703 "UrlDispatchRule": { |
| 704 "description": "Rules to match an HTTP request and dispatch that req
uest to a service.", |
| 705 "id": "UrlDispatchRule", |
| 706 "properties": { |
| 707 "domain": { |
| 708 "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 '*').", |
| 709 "type": "string" |
| 710 }, |
| 711 "path": { |
| 712 "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.", |
| 713 "type": "string" |
| 714 }, |
| 715 "service": { |
| 716 "description": "The resource id of a Service in this applica
tion that should service the matched request. The Service must already exist. Ex
ample: \"default\".", |
| 717 "type": "string" |
| 718 } |
| 719 }, |
| 720 "type": "object" |
| 721 }, |
| 722 "Version": { |
| 723 "description": "A Version is a specific set of source code and confi
guration files deployed to a service.", |
| 724 "id": "Version", |
| 725 "properties": { |
| 726 "name": { |
| 727 "description": "The full path to the Version resource in the
API. Example: \"apps/myapp/services/default/versions/v1\". @OutputOnly", |
| 728 "type": "string" |
| 729 }, |
| 730 "id": { |
| 731 "description": "The relative name/path of the Version within
the service. Example: \"v1\". Version specifiers can contain lowercase letters,
digits, and hyphens. It cannot begin with the prefix `ah-` and the names `defau
lt` and `latest` are reserved and cannot be used.", |
| 732 "type": "string" |
| 733 }, |
| 734 "automaticScaling": { |
| 735 "$ref": "AutomaticScaling", |
| 736 "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." |
| 737 }, |
| 738 "basicScaling": { |
| 739 "$ref": "BasicScaling", |
| 740 "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." |
| 741 }, |
| 742 "manualScaling": { |
| 743 "$ref": "ManualScaling", |
| 744 "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." |
| 745 }, |
| 746 "inboundServices": { |
| 747 "description": "Before an application can receive email or X
MPP messages, the application must be configured to enable the service.", |
| 748 "enumDescriptions": [ |
| 749 "Not specified.", |
| 750 "Allows an application to receive mail.", |
| 751 "Allows an application receive email bound notifications
.", |
| 752 "Allows an application to receive error stanzas.", |
| 753 "Allows an application to receive instant messages.", |
| 754 "Allows an application to receive user subscription POST
s.", |
| 755 "Allows an application to receive a user's chat presence
.", |
| 756 "Registers an application for notifications when a clien
t connects or disconnects from a channel.", |
| 757 "Enables warmup requests." |
| 758 ], |
| 759 "items": { |
| 760 "enum": [ |
| 761 "INBOUND_SERVICE_UNSPECIFIED", |
| 762 "INBOUND_SERVICE_MAIL", |
| 763 "INBOUND_SERVICE_MAIL_BOUNCE", |
| 764 "INBOUND_SERVICE_XMPP_ERROR", |
| 765 "INBOUND_SERVICE_XMPP_MESSAGE", |
| 766 "INBOUND_SERVICE_XMPP_SUBSCRIBE", |
| 767 "INBOUND_SERVICE_XMPP_PRESENCE", |
| 768 "INBOUND_SERVICE_CHANNEL_PRESENCE", |
| 769 "INBOUND_SERVICE_WARMUP" |
| 770 ], |
| 771 "type": "string" |
| 772 }, |
| 773 "type": "array" |
| 774 }, |
| 775 "instanceClass": { |
| 776 "description": "The instance class to use to run this app. V
alid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for Man
ualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: \"F1\" for A
utomaticScaling, \"B1\" for ManualScaling and BasicScaling", |
| 777 "type": "string" |
| 778 }, |
| 779 "network": { |
| 780 "$ref": "Network", |
| 781 "description": "Used to specify extra network settings (for
VM runtimes only)." |
| 782 }, |
| 783 "resources": { |
| 784 "$ref": "Resources", |
| 785 "description": "Used to specify how many machine resources a
n app version needs (for VM runtimes only)." |
| 786 }, |
| 787 "runtime": { |
| 788 "description": "The desired runtime. Values can include pyth
on27, java7, go, etc.", |
| 789 "type": "string" |
| 790 }, |
| 791 "threadsafe": { |
| 792 "description": "If true, multiple requests can be dispatched
to the app at once.", |
| 793 "type": "boolean" |
| 794 }, |
| 795 "vm": { |
| 796 "description": "Whether to deploy this app in a VM container
.", |
| 797 "type": "boolean" |
| 798 }, |
| 799 "betaSettings": { |
| 800 "additionalProperties": { |
| 801 "type": "string" |
| 802 }, |
| 803 "description": "Beta settings supplied to the application vi
a metadata.", |
| 804 "type": "object" |
| 805 }, |
| 806 "env": { |
| 807 "description": "The App Engine execution environment to use
for this version. Default: \"1\"", |
| 808 "type": "string" |
| 809 }, |
| 810 "servingStatus": { |
| 811 "description": "The current serving status of this version.
Only `SERVING` versions will have instances created or billed for. If this field
is unset when a version is created, `SERVING` status will be assumed. It is an
error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.", |
| 812 "enum": [ |
| 813 "SERVING_STATUS_UNSPECIFIED", |
| 814 "SERVING", |
| 815 "STOPPED" |
| 816 ], |
| 817 "type": "string" |
| 818 }, |
| 819 "deployer": { |
| 820 "description": "The email address of the user who created th
is version. @OutputOnly", |
| 821 "type": "string" |
| 822 }, |
| 823 "creationTime": { |
| 824 "description": "Creation time of this version. This will be
between the start and end times of the operation that creates this version. @Out
putOnly", |
| 825 "type": "string" |
| 826 }, |
| 827 "diskUsageBytes": { |
| 828 "description": "Total size of version files hosted on App En
gine disk in bytes. @OutputOnly", |
| 829 "format": "int64", |
| 830 "type": "string" |
| 831 }, |
| 832 "handlers": { |
| 833 "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.", |
| 834 "items": { |
| 835 "$ref": "UrlMap" |
| 836 }, |
| 837 "type": "array" |
| 838 }, |
| 839 "errorHandlers": { |
| 840 "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.", |
| 841 "items": { |
| 842 "$ref": "ErrorHandler" |
| 843 }, |
| 844 "type": "array" |
| 845 }, |
| 846 "libraries": { |
| 847 "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.", |
| 848 "items": { |
| 849 "$ref": "Library" |
| 850 }, |
| 851 "type": "array" |
| 852 }, |
| 853 "apiConfig": { |
| 854 "$ref": "ApiConfigHandler", |
| 855 "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." |
| 856 }, |
| 857 "envVariables": { |
| 858 "additionalProperties": { |
| 859 "type": "string" |
| 860 }, |
| 861 "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.", |
| 862 "type": "object" |
| 863 }, |
| 864 "defaultExpiration": { |
| 865 "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."
, |
| 866 "type": "string" |
| 867 }, |
| 868 "healthCheck": { |
| 869 "$ref": "HealthCheck", |
| 870 "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." |
| 871 }, |
| 872 "nobuildFilesRegex": { |
| 873 "description": "Go only. Files that match this pattern will
not be built into the app. May only be set on create requests.", |
| 874 "type": "string" |
| 875 }, |
| 876 "deployment": { |
| 877 "$ref": "Deployment", |
| 878 "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." |
| 879 } |
| 880 }, |
| 881 "type": "object" |
| 882 }, |
| 883 "AutomaticScaling": { |
| 884 "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.", |
| 885 "id": "AutomaticScaling", |
| 886 "properties": { |
| 887 "coolDownPeriod": { |
| 888 "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.", |
| 889 "type": "string" |
| 890 }, |
| 891 "cpuUtilization": { |
| 892 "$ref": "CpuUtilization", |
| 893 "description": "Target scaling by CPU usage." |
| 894 }, |
| 895 "maxConcurrentRequests": { |
| 896 "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.", |
| 897 "format": "int32", |
| 898 "type": "integer" |
| 899 }, |
| 900 "maxIdleInstances": { |
| 901 "description": "The maximum number of idle instances that Ap
p Engine should maintain for this version.", |
| 902 "format": "int32", |
| 903 "type": "integer" |
| 904 }, |
| 905 "maxTotalInstances": { |
| 906 "description": "Max number of instances that App Engine shou
ld start to handle requests.", |
| 907 "format": "int32", |
| 908 "type": "integer" |
| 909 }, |
| 910 "maxPendingLatency": { |
| 911 "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.", |
| 912 "type": "string" |
| 913 }, |
| 914 "minIdleInstances": { |
| 915 "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 service, since other versions are not expected to receive significant traffi
c.", |
| 916 "format": "int32", |
| 917 "type": "integer" |
| 918 }, |
| 919 "minTotalInstances": { |
| 920 "description": "Minimum number of instances that App Engine
should maintain.", |
| 921 "format": "int32", |
| 922 "type": "integer" |
| 923 }, |
| 924 "minPendingLatency": { |
| 925 "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.", |
| 926 "type": "string" |
| 927 }, |
| 928 "requestUtilization": { |
| 929 "$ref": "RequestUtilization", |
| 930 "description": "Target scaling by request utilization." |
| 931 }, |
| 932 "diskUtilization": { |
| 933 "$ref": "DiskUtilization", |
| 934 "description": "Target scaling by disk usage." |
| 935 }, |
| 936 "networkUtilization": { |
| 937 "$ref": "NetworkUtilization", |
| 938 "description": "Target scaling by network usage." |
| 939 } |
| 940 }, |
| 941 "type": "object" |
| 942 }, |
| 943 "CpuUtilization": { |
| 944 "description": "Target scaling by CPU usage.", |
| 945 "id": "CpuUtilization", |
| 946 "properties": { |
| 947 "aggregationWindowLength": { |
| 948 "description": "The period of time over which CPU utilizatio
n is calculated.", |
| 949 "type": "string" |
| 950 }, |
| 951 "targetUtilization": { |
| 952 "description": "Target (0-1) CPU utilization ratio to mainta
in when scaling.", |
| 953 "format": "double", |
| 954 "type": "number" |
| 955 } |
| 956 }, |
| 957 "type": "object" |
| 958 }, |
| 959 "RequestUtilization": { |
| 960 "description": "Target scaling by request utilization (for VM runtim
es only).", |
| 961 "id": "RequestUtilization", |
| 962 "properties": { |
| 963 "targetRequestCountPerSec": { |
| 964 "description": "Target requests per second.", |
| 965 "format": "int32", |
| 966 "type": "integer" |
| 967 }, |
| 968 "targetConcurrentRequests": { |
| 969 "description": "Target number of concurrent requests.", |
| 970 "format": "int32", |
| 971 "type": "integer" |
| 972 } |
| 973 }, |
| 974 "type": "object" |
| 975 }, |
| 976 "DiskUtilization": { |
| 977 "description": "Target scaling by disk usage (for VM runtimes only).
", |
| 978 "id": "DiskUtilization", |
| 979 "properties": { |
| 980 "targetWriteBytesPerSec": { |
| 981 "description": "Target bytes per second written.", |
| 982 "format": "int32", |
| 983 "type": "integer" |
| 984 }, |
| 985 "targetWriteOpsPerSec": { |
| 986 "description": "Target ops per second written.", |
| 987 "format": "int32", |
| 988 "type": "integer" |
| 989 }, |
| 990 "targetReadBytesPerSec": { |
| 991 "description": "Target bytes per second read.", |
| 992 "format": "int32", |
| 993 "type": "integer" |
| 994 }, |
| 995 "targetReadOpsPerSec": { |
| 996 "description": "Target ops per second read.", |
| 997 "format": "int32", |
| 998 "type": "integer" |
| 999 } |
| 1000 }, |
| 1001 "type": "object" |
| 1002 }, |
| 1003 "NetworkUtilization": { |
| 1004 "description": "Target scaling by network usage (for VM runtimes onl
y).", |
| 1005 "id": "NetworkUtilization", |
| 1006 "properties": { |
| 1007 "targetSentBytesPerSec": { |
| 1008 "description": "Target bytes per second sent.", |
| 1009 "format": "int32", |
| 1010 "type": "integer" |
| 1011 }, |
| 1012 "targetSentPacketsPerSec": { |
| 1013 "description": "Target packets per second sent.", |
| 1014 "format": "int32", |
| 1015 "type": "integer" |
| 1016 }, |
| 1017 "targetReceivedBytesPerSec": { |
| 1018 "description": "Target bytes per second received.", |
| 1019 "format": "int32", |
| 1020 "type": "integer" |
| 1021 }, |
| 1022 "targetReceivedPacketsPerSec": { |
| 1023 "description": "Target packets per second received.", |
| 1024 "format": "int32", |
| 1025 "type": "integer" |
| 1026 } |
| 1027 }, |
| 1028 "type": "object" |
| 1029 }, |
| 1030 "BasicScaling": { |
| 1031 "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.", |
| 1032 "id": "BasicScaling", |
| 1033 "properties": { |
| 1034 "idleTimeout": { |
| 1035 "description": "The instance will be shut down this amount o
f time after receiving its last request.", |
| 1036 "type": "string" |
| 1037 }, |
| 1038 "maxInstances": { |
| 1039 "description": "The maximum number of instances for App Engi
ne to create for this version.", |
| 1040 "format": "int32", |
| 1041 "type": "integer" |
| 1042 } |
| 1043 }, |
| 1044 "type": "object" |
| 1045 }, |
| 1046 "ManualScaling": { |
| 1047 "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.", |
| 1048 "id": "ManualScaling", |
| 1049 "properties": { |
| 1050 "instances": { |
| 1051 "description": "The number of instances to assign to the ser
vice at the start. This number can later be altered by using the [Modules API](h
ttps://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instan
ces()` function.", |
| 1052 "format": "int32", |
| 1053 "type": "integer" |
| 1054 } |
| 1055 }, |
| 1056 "type": "object" |
| 1057 }, |
| 1058 "Network": { |
| 1059 "description": "Used to specify extra network settings (for VM runti
mes only).", |
| 1060 "id": "Network", |
| 1061 "properties": { |
| 1062 "forwardedPorts": { |
| 1063 "description": "A list of ports (or port pairs) to forward f
rom the VM into the app container.", |
| 1064 "items": { |
| 1065 "type": "string" |
| 1066 }, |
| 1067 "type": "array" |
| 1068 }, |
| 1069 "instanceTag": { |
| 1070 "description": "A tag to apply to the VM instance during cre
ation.", |
| 1071 "type": "string" |
| 1072 }, |
| 1073 "name": { |
| 1074 "description": "The Google Compute Engine network where the
VMs will be created. If not specified, or empty, the network named \"default\" w
ill be used. (The short name should be specified, not the resource path.)", |
| 1075 "type": "string" |
| 1076 } |
| 1077 }, |
| 1078 "type": "object" |
| 1079 }, |
| 1080 "Resources": { |
| 1081 "description": "Used to specify how many machine resources an app ve
rsion needs.", |
| 1082 "id": "Resources", |
| 1083 "properties": { |
| 1084 "cpu": { |
| 1085 "description": "How many CPU cores an app version needs.", |
| 1086 "format": "double", |
| 1087 "type": "number" |
| 1088 }, |
| 1089 "diskGb": { |
| 1090 "description": "How much disk size, in GB, an app version ne
eds.", |
| 1091 "format": "double", |
| 1092 "type": "number" |
| 1093 }, |
| 1094 "memoryGb": { |
| 1095 "description": "How much memory, in GB, an app version needs
.", |
| 1096 "format": "double", |
| 1097 "type": "number" |
| 1098 } |
| 1099 }, |
| 1100 "type": "object" |
| 1101 }, |
| 1102 "UrlMap": { |
| 1103 "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.", |
| 1104 "id": "UrlMap", |
| 1105 "properties": { |
| 1106 "urlRegex": { |
| 1107 "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.", |
| 1108 "type": "string" |
| 1109 }, |
| 1110 "staticFiles": { |
| 1111 "$ref": "StaticFilesHandler", |
| 1112 "description": "Returns the contents of a file, such as an i
mage, as the response." |
| 1113 }, |
| 1114 "script": { |
| 1115 "$ref": "ScriptHandler", |
| 1116 "description": "Executes a script to handle the request that
matches the URL pattern." |
| 1117 }, |
| 1118 "apiEndpoint": { |
| 1119 "$ref": "ApiEndpointHandler", |
| 1120 "description": "Use API Endpoints to handle requests." |
| 1121 }, |
| 1122 "securityLevel": { |
| 1123 "description": "Configures whether security (HTTPS) should b
e enforced for this URL.", |
| 1124 "enum": [ |
| 1125 "SECURE_UNSPECIFIED", |
| 1126 "SECURE_DEFAULT", |
| 1127 "SECURE_NEVER", |
| 1128 "SECURE_OPTIONAL", |
| 1129 "SECURE_ALWAYS" |
| 1130 ], |
| 1131 "type": "string" |
| 1132 }, |
| 1133 "login": { |
| 1134 "description": "What level of login is required to access th
is resource.", |
| 1135 "enum": [ |
| 1136 "LOGIN_UNSPECIFIED", |
| 1137 "LOGIN_OPTIONAL", |
| 1138 "LOGIN_ADMIN", |
| 1139 "LOGIN_REQUIRED" |
| 1140 ], |
| 1141 "type": "string" |
| 1142 }, |
| 1143 "authFailAction": { |
| 1144 "description": "For users not logged in, how to handle acces
s to resources with required login. Defaults to \"redirect\".", |
| 1145 "enum": [ |
| 1146 "AUTH_FAIL_ACTION_UNSPECIFIED", |
| 1147 "AUTH_FAIL_ACTION_REDIRECT", |
| 1148 "AUTH_FAIL_ACTION_UNAUTHORIZED" |
| 1149 ], |
| 1150 "type": "string" |
| 1151 }, |
| 1152 "redirectHttpResponseCode": { |
| 1153 "description": "`30x` code to use when performing redirects
for the `secure` field. A `302` is used by default.", |
| 1154 "enum": [ |
| 1155 "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", |
| 1156 "REDIRECT_HTTP_RESPONSE_CODE_301", |
| 1157 "REDIRECT_HTTP_RESPONSE_CODE_302", |
| 1158 "REDIRECT_HTTP_RESPONSE_CODE_303", |
| 1159 "REDIRECT_HTTP_RESPONSE_CODE_307" |
| 1160 ], |
| 1161 "type": "string" |
| 1162 } |
| 1163 }, |
| 1164 "type": "object" |
| 1165 }, |
| 1166 "StaticFilesHandler": { |
| 1167 "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.", |
| 1168 "id": "StaticFilesHandler", |
| 1169 "properties": { |
| 1170 "path": { |
| 1171 "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.", |
| 1172 "type": "string" |
| 1173 }, |
| 1174 "uploadPathRegex": { |
| 1175 "description": "A regular expression that matches the file p
aths for all files that will be referenced by this handler.", |
| 1176 "type": "string" |
| 1177 }, |
| 1178 "httpHeaders": { |
| 1179 "additionalProperties": { |
| 1180 "type": "string" |
| 1181 }, |
| 1182 "description": "HTTP headers to use for all responses from t
hese URLs.", |
| 1183 "type": "object" |
| 1184 }, |
| 1185 "mimeType": { |
| 1186 "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.", |
| 1187 "type": "string" |
| 1188 }, |
| 1189 "expiration": { |
| 1190 "description": "The length of time a static file served by t
his handler ought to be cached by web proxies and browsers.", |
| 1191 "type": "string" |
| 1192 }, |
| 1193 "requireMatchingFile": { |
| 1194 "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.", |
| 1195 "type": "boolean" |
| 1196 }, |
| 1197 "applicationReadable": { |
| 1198 "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.", |
| 1199 "type": "boolean" |
| 1200 } |
| 1201 }, |
| 1202 "type": "object" |
| 1203 }, |
| 1204 "ScriptHandler": { |
| 1205 "description": "Executes a script to handle the request that matches
the URL pattern.", |
| 1206 "id": "ScriptHandler", |
| 1207 "properties": { |
| 1208 "scriptPath": { |
| 1209 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 1210 "type": "string" |
| 1211 } |
| 1212 }, |
| 1213 "type": "object" |
| 1214 }, |
| 1215 "ApiEndpointHandler": { |
| 1216 "description": "Use Google Cloud Endpoints to handle requests.", |
| 1217 "id": "ApiEndpointHandler", |
| 1218 "properties": { |
| 1219 "scriptPath": { |
| 1220 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 1221 "type": "string" |
| 1222 } |
| 1223 }, |
| 1224 "type": "object" |
| 1225 }, |
| 1226 "ErrorHandler": { |
| 1227 "description": "A custom static error page to be served when an erro
r occurs.", |
| 1228 "id": "ErrorHandler", |
| 1229 "properties": { |
| 1230 "errorCode": { |
| 1231 "description": "The error condition this handler applies to.
", |
| 1232 "enum": [ |
| 1233 "ERROR_CODE_UNSPECIFIED", |
| 1234 "ERROR_CODE_DEFAULT", |
| 1235 "ERROR_CODE_OVER_QUOTA", |
| 1236 "ERROR_CODE_DOS_API_DENIAL", |
| 1237 "ERROR_CODE_TIMEOUT" |
| 1238 ], |
| 1239 "type": "string" |
| 1240 }, |
| 1241 "staticFile": { |
| 1242 "description": "Static file content to be served for this er
ror.", |
| 1243 "type": "string" |
| 1244 }, |
| 1245 "mimeType": { |
| 1246 "description": "MIME type of file. If unspecified, \"text/ht
ml\" is assumed.", |
| 1247 "type": "string" |
| 1248 } |
| 1249 }, |
| 1250 "type": "object" |
| 1251 }, |
| 1252 "Library": { |
| 1253 "description": "A Python runtime third-party library required by the
application.", |
| 1254 "id": "Library", |
| 1255 "properties": { |
| 1256 "name": { |
| 1257 "description": "The name of the library, e.g. \"PIL\" or \"d
jango\".", |
| 1258 "type": "string" |
| 1259 }, |
| 1260 "version": { |
| 1261 "description": "The version of the library to select, or \"l
atest\".", |
| 1262 "type": "string" |
| 1263 } |
| 1264 }, |
| 1265 "type": "object" |
| 1266 }, |
| 1267 "ApiConfigHandler": { |
| 1268 "description": "API Serving configuration for Cloud Endpoints.", |
| 1269 "id": "ApiConfigHandler", |
| 1270 "properties": { |
| 1271 "authFailAction": { |
| 1272 "description": "For users not logged in, how to handle acces
s to resources with required login. Defaults to \"redirect\".", |
| 1273 "enum": [ |
| 1274 "AUTH_FAIL_ACTION_UNSPECIFIED", |
| 1275 "AUTH_FAIL_ACTION_REDIRECT", |
| 1276 "AUTH_FAIL_ACTION_UNAUTHORIZED" |
| 1277 ], |
| 1278 "type": "string" |
| 1279 }, |
| 1280 "login": { |
| 1281 "description": "What level of login is required to access th
is resource. Default is \"optional\".", |
| 1282 "enum": [ |
| 1283 "LOGIN_UNSPECIFIED", |
| 1284 "LOGIN_OPTIONAL", |
| 1285 "LOGIN_ADMIN", |
| 1286 "LOGIN_REQUIRED" |
| 1287 ], |
| 1288 "type": "string" |
| 1289 }, |
| 1290 "script": { |
| 1291 "description": "Specifies the path to the script from the ap
plication root directory.", |
| 1292 "type": "string" |
| 1293 }, |
| 1294 "securityLevel": { |
| 1295 "description": "Configures whether security (HTTPS) should b
e enforced for this URL.", |
| 1296 "enum": [ |
| 1297 "SECURE_UNSPECIFIED", |
| 1298 "SECURE_DEFAULT", |
| 1299 "SECURE_NEVER", |
| 1300 "SECURE_OPTIONAL", |
| 1301 "SECURE_ALWAYS" |
| 1302 ], |
| 1303 "type": "string" |
| 1304 }, |
| 1305 "url": { |
| 1306 "description": "URL to serve the endpoint at.", |
| 1307 "type": "string" |
| 1308 } |
| 1309 }, |
| 1310 "type": "object" |
| 1311 }, |
| 1312 "HealthCheck": { |
| 1313 "description": "Configure health checking for the VM instances. Unhe
althy VM instances will be killed and replaced with new instances.", |
| 1314 "id": "HealthCheck", |
| 1315 "properties": { |
| 1316 "disableHealthCheck": { |
| 1317 "description": "Whether to explicitly disable health checks
for this instance.", |
| 1318 "type": "boolean" |
| 1319 }, |
| 1320 "host": { |
| 1321 "description": "The host header to send when performing an H
TTP health check (e.g. myapp.appspot.com)", |
| 1322 "type": "string" |
| 1323 }, |
| 1324 "healthyThreshold": { |
| 1325 "description": "The number of consecutive successful health
checks before receiving traffic.", |
| 1326 "format": "uint32", |
| 1327 "type": "integer" |
| 1328 }, |
| 1329 "unhealthyThreshold": { |
| 1330 "description": "The number of consecutive failed health chec
ks before removing traffic.", |
| 1331 "format": "uint32", |
| 1332 "type": "integer" |
| 1333 }, |
| 1334 "restartThreshold": { |
| 1335 "description": "The number of consecutive failed health chec
ks before an instance is restarted.", |
| 1336 "format": "uint32", |
| 1337 "type": "integer" |
| 1338 }, |
| 1339 "checkInterval": { |
| 1340 "description": "The interval between health checks.", |
| 1341 "type": "string" |
| 1342 }, |
| 1343 "timeout": { |
| 1344 "description": "The amount of time before the health check i
s considered failed.", |
| 1345 "type": "string" |
| 1346 } |
| 1347 }, |
| 1348 "type": "object" |
| 1349 }, |
| 1350 "Deployment": { |
| 1351 "description": "Code and application artifacts used to deploy a vers
ion to App Engine.", |
| 1352 "id": "Deployment", |
| 1353 "properties": { |
| 1354 "files": { |
| 1355 "additionalProperties": { |
| 1356 "$ref": "FileInfo" |
| 1357 }, |
| 1358 "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.", |
| 1359 "type": "object" |
| 1360 }, |
| 1361 "container": { |
| 1362 "$ref": "ContainerInfo", |
| 1363 "description": "If supplied, a docker (container) image whic
h should be used to start the application. Only applicable to the 'vm' runtime." |
| 1364 }, |
| 1365 "sourceReferences": { |
| 1366 "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.", |
| 1367 "items": { |
| 1368 "$ref": "SourceReference" |
| 1369 }, |
| 1370 "type": "array" |
| 1371 } |
| 1372 }, |
| 1373 "type": "object" |
| 1374 }, |
| 1375 "FileInfo": { |
| 1376 "description": "A single source file which is part of the applicatio
n to be deployed.", |
| 1377 "id": "FileInfo", |
| 1378 "properties": { |
| 1379 "sourceUrl": { |
| 1380 "description": "The URL source to use to fetch this file. Mu
st be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage
.googleapis.com/\\/\\'.", |
| 1381 "type": "string" |
| 1382 }, |
| 1383 "sha1Sum": { |
| 1384 "description": "The SHA1 (160 bits) hash of the file in hex.
", |
| 1385 "type": "string" |
| 1386 }, |
| 1387 "mimeType": { |
| 1388 "description": "The MIME type of the file; if unspecified, t
he value from Google Cloud Storage will be used.", |
| 1389 "type": "string" |
| 1390 } |
| 1391 }, |
| 1392 "type": "object" |
| 1393 }, |
| 1394 "ContainerInfo": { |
| 1395 "description": "A Docker (container) image which should be used to s
tart the application.", |
| 1396 "id": "ContainerInfo", |
| 1397 "properties": { |
| 1398 "image": { |
| 1399 "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", |
| 1400 "type": "string" |
| 1401 } |
| 1402 }, |
| 1403 "type": "object" |
| 1404 }, |
| 1405 "SourceReference": { |
| 1406 "description": "A reference to a particular snapshot of the source t
ree used to build and deploy the application.", |
| 1407 "id": "SourceReference", |
| 1408 "properties": { |
| 1409 "repository": { |
| 1410 "description": "Optional. A URI string identifying the repos
itory. Example: \"https://source.developers.google.com/p/app-123/r/default\"", |
| 1411 "type": "string" |
| 1412 }, |
| 1413 "revisionId": { |
| 1414 "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\"", |
| 1415 "type": "string" |
| 1416 } |
| 1417 }, |
| 1418 "type": "object" |
| 1419 }, |
| 1420 "ListVersionsResponse": { |
| 1421 "description": "Response message for `Versions.ListVersions`.", |
| 1422 "id": "ListVersionsResponse", |
| 1423 "properties": { |
| 1424 "versions": { |
| 1425 "description": "The versions belonging to the requested appl
ication service.", |
| 1426 "items": { |
| 1427 "$ref": "Version" |
| 1428 }, |
| 1429 "type": "array" |
| 1430 }, |
| 1431 "nextPageToken": { |
| 1432 "description": "Continuation token for fetching the next pag
e of results.", |
| 1433 "type": "string" |
| 1434 } |
| 1435 }, |
| 1436 "type": "object" |
| 1437 }, |
| 1438 "Service": { |
| 1439 "description": "A service is a logical component of an application t
hat can share state and communicate in a secure fashion with other services. For
example, an application that handles customer requests might include separate s
ervices to handle other tasks such as API requests from mobile devices or backen
d data analysis. Each service has a collection of versions that define a specifi
c set of code used to implement the functionality of that service.", |
| 1440 "id": "Service", |
| 1441 "properties": { |
| 1442 "name": { |
| 1443 "description": "The full path to the Service resource in the
API. Example: \"apps/myapp/services/default\" @OutputOnly", |
| 1444 "type": "string" |
| 1445 }, |
| 1446 "id": { |
| 1447 "description": "The relative name/path of the service within
the application. Example: \"default\" @OutputOnly", |
| 1448 "type": "string" |
| 1449 }, |
| 1450 "split": { |
| 1451 "$ref": "TrafficSplit", |
| 1452 "description": "A mapping that defines fractional HTTP traff
ic diversion to different versions within the service." |
| 1453 } |
| 1454 }, |
| 1455 "type": "object" |
| 1456 }, |
| 1457 "TrafficSplit": { |
| 1458 "description": "Configuration for traffic splitting for versions wit
hin a single service. Traffic splitting allows traffic directed to the service t
o be assigned to one of several versions in a fractional way, enabling experimen
ts and canarying new builds, for example.", |
| 1459 "id": "TrafficSplit", |
| 1460 "properties": { |
| 1461 "shardBy": { |
| 1462 "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.", |
| 1463 "enum": [ |
| 1464 "UNSPECIFIED", |
| 1465 "COOKIE", |
| 1466 "IP" |
| 1467 ], |
| 1468 "type": "string" |
| 1469 }, |
| 1470 "allocations": { |
| 1471 "additionalProperties": { |
| 1472 "format": "double", |
| 1473 "type": "number" |
| 1474 }, |
| 1475 "description": "Mapping from service version IDs within the
service to fractional (0.000, 1] allocations of traffic for that version. Each v
ersion may only be specified once, but some versions in the service may not have
any traffic allocation. Services that have traffic allocated in this field may
not be deleted until the service is deleted, or their traffic allocation is remo
ved. Allocations must sum to 1. Supports precision up to two decimal places for
IP-based splits and up to three decimal places for cookie-based splits.", |
| 1476 "type": "object" |
| 1477 } |
| 1478 }, |
| 1479 "type": "object" |
| 1480 }, |
| 1481 "ListServicesResponse": { |
| 1482 "description": "Response message for `Services.ListServices`.", |
| 1483 "id": "ListServicesResponse", |
| 1484 "properties": { |
| 1485 "services": { |
| 1486 "description": "The services belonging to the requested appl
ication.", |
| 1487 "items": { |
| 1488 "$ref": "Service" |
| 1489 }, |
| 1490 "type": "array" |
| 1491 }, |
| 1492 "nextPageToken": { |
| 1493 "description": "Continuation token for fetching the next pag
e of results.", |
| 1494 "type": "string" |
| 1495 } |
| 1496 }, |
| 1497 "type": "object" |
| 1498 }, |
| 1499 "OperationMetadata": { |
| 1500 "description": "Metadata for the given google.longrunning.Operation.
", |
| 1501 "id": "OperationMetadata", |
| 1502 "properties": { |
| 1503 "operationType": { |
| 1504 "description": "The type of the operation (deprecated, use m
ethod field instead). Example: \"create_version\". @OutputOnly", |
| 1505 "type": "string" |
| 1506 }, |
| 1507 "insertTime": { |
| 1508 "description": "Timestamp that this operation was received.
@OutputOnly", |
| 1509 "type": "string" |
| 1510 }, |
| 1511 "endTime": { |
| 1512 "description": "Timestamp that this operation was completed.
(Not present if the operation is still in progress.) @OutputOnly", |
| 1513 "type": "string" |
| 1514 }, |
| 1515 "user": { |
| 1516 "description": "The user who requested this operation. @Outp
utOnly", |
| 1517 "type": "string" |
| 1518 }, |
| 1519 "target": { |
| 1520 "description": "Resource that this operation is acting on. E
xample: \"apps/myapp/modules/default\". @OutputOnly", |
| 1521 "type": "string" |
| 1522 }, |
| 1523 "method": { |
| 1524 "description": "API method name that initiated the operation
. Example: \"google.appengine.v1beta4.Version.CreateVersion\". @OutputOnly", |
| 1525 "type": "string" |
| 1526 } |
| 1527 }, |
| 1528 "type": "object" |
| 1529 }, |
| 1530 "OperationMetadataV1Beta5": { |
| 1531 "description": "Metadata for the given google.longrunning.Operation.
", |
| 1532 "id": "OperationMetadataV1Beta5", |
| 1533 "properties": { |
| 1534 "method": { |
| 1535 "description": "API method name that initiated the operation
. Example: \"google.appengine.v1beta5.Version.CreateVersion\". @OutputOnly", |
| 1536 "type": "string" |
| 1537 }, |
| 1538 "insertTime": { |
| 1539 "description": "Timestamp that this operation was received.
@OutputOnly", |
| 1540 "type": "string" |
| 1541 }, |
| 1542 "endTime": { |
| 1543 "description": "Timestamp that this operation was completed.
(Not present if the operation is still in progress.) @OutputOnly", |
| 1544 "type": "string" |
| 1545 }, |
| 1546 "user": { |
| 1547 "description": "The user who requested this operation. @Outp
utOnly", |
| 1548 "type": "string" |
| 1549 }, |
| 1550 "target": { |
| 1551 "description": "Resource that this operation is acting on. E
xample: \"apps/myapp/services/default\". @OutputOnly", |
| 1552 "type": "string" |
| 1553 } |
| 1554 }, |
| 1555 "type": "object" |
| 1556 } |
| 1557 }, |
| 1558 "servicePath": "", |
| 1559 "title": "Google App Engine Admin API", |
| 1560 "version": "v1beta5" |
| 1561 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 1797933002:
Api-roll 33: 2016-03-14 (Closed)
Base URL: git@github.com:dart-lang/googleapis.git@master