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

Unified Diff: discovery/googleapis_beta/appengine__v1beta.json

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: discovery/googleapis_beta/appengine__v1beta.json
diff --git a/discovery/googleapis_beta/appengine__v1beta.json b/discovery/googleapis_beta/appengine__v1beta.json
index 6b41d210a879ee4f90b31382fc3373716e82f90d..d4ccee95dd05d89a58a208fa885dcbd8f936e59c 100644
--- a/discovery/googleapis_beta/appengine__v1beta.json
+++ b/discovery/googleapis_beta/appengine__v1beta.json
@@ -2,12 +2,12 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
}
@@ -17,10 +17,9 @@
"basePath": "",
"baseUrl": "https://appengine.googleapis.com/",
"batchPath": "batch",
- "description": "Provisions and manages App Engine applications.",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/0wieiWOLZ-Vm6vgB6dsBIuzASBg\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -36,34 +35,24 @@
"location": "query",
"type": "string"
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
"location": "query",
- "type": "string"
+ "type": "boolean"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
@@ -72,11 +61,10 @@
"location": "query",
"type": "string"
},
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
- "type": "boolean"
+ "type": "string"
},
"prettyPrint": {
"default": "true",
@@ -84,29 +72,49 @@
"location": "query",
"type": "boolean"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "callback": {
+ "description": "JSONP",
"location": "query",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
}
},
"protocol": "rest",
@@ -138,23 +146,8 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "create": {
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "httpMethod": "POST",
- "id": "appengine.apps.create",
- "path": "v1beta/apps",
- "request": {
- "$ref": "Application"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"patch": {
- "description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
"httpMethod": "PATCH",
"id": "appengine.apps.patch",
"parameterOrder": [
@@ -169,6 +162,7 @@
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
"location": "query",
"type": "string"
}
@@ -184,6 +178,23 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "httpMethod": "POST",
+ "id": "appengine.apps.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1beta/apps",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"repair": {
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
"httpMethod": "POST",
@@ -212,32 +223,32 @@
}
},
"resources": {
- "operations": {
+ "locations": {
"methods": {
"list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
+ "description": "Lists information about the supported locations for this service.",
"httpMethod": "GET",
- "id": "appengine.apps.operations.list",
+ "id": "appengine.apps.locations.list",
"parameterOrder": [
"appsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation collection.",
- "location": "path",
- "required": true,
- "type": "string"
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "location": "query",
- "type": "integer"
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"pageToken": {
"description": "The standard list page token.",
@@ -245,9 +256,9 @@
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/operations",
+ "path": "v1beta/apps/{appsId}/locations",
"response": {
- "$ref": "ListOperationsResponse"
+ "$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -256,30 +267,30 @@
]
},
"get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "description": "Get information about a location.",
"httpMethod": "GET",
- "id": "appengine.apps.operations.get",
+ "id": "appengine.apps.locations.get",
"parameterOrder": [
"appsId",
- "operationsId"
+ "locationsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
"response": {
- "$ref": "Operation"
+ "$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -289,12 +300,42 @@
}
}
},
- "services": {
+ "authorizedCertificates": {
"methods": {
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"list": {
- "description": "Lists all the services in the application.",
+ "description": "Lists all SSL certificates the user is authorized to administer.",
"httpMethod": "GET",
- "id": "appengine.apps.services.list",
+ "id": "appengine.apps.authorizedCertificates.list",
"parameterOrder": [
"appsId"
],
@@ -305,21 +346,21 @@
"required": true,
"type": "string"
},
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
- "type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
"response": {
- "$ref": "ListServicesResponse"
+ "$ref": "ListAuthorizedCertificatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -328,30 +369,39 @@
]
},
"get": {
- "description": "Gets the current configuration of the specified service.",
+ "description": "Gets the specified SSL certificate.",
"httpMethod": "GET",
- "id": "appengine.apps.services.get",
+ "id": "appengine.apps.authorizedCertificates.get",
"parameterOrder": [
"appsId",
- "servicesId"
+ "authorizedCertificatesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "view": {
+ "description": "Controls the set of fields returned in the GET response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"response": {
- "$ref": "Service"
+ "$ref": "AuthorizedCertificate"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -360,71 +410,209 @@
]
},
"patch": {
- "description": "Updates the configuration of the specified service.",
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
"httpMethod": "PATCH",
- "id": "appengine.apps.services.patch",
+ "id": "appengine.apps.authorizedCertificates.patch",
"parameterOrder": [
"appsId",
- "servicesId"
+ "authorizedCertificatesId"
],
"parameters": {
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
"appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"location": "path",
"required": true,
"type": "string"
},
- "servicesId": {
+ "authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "location": "query",
- "type": "string"
- },
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "location": "query",
- "type": "boolean"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"request": {
- "$ref": "Service"
+ "$ref": "AuthorizedCertificate"
},
"response": {
- "$ref": "Operation"
+ "$ref": "AuthorizedCertificate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.delete",
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.get",
"parameterOrder": [
"appsId",
"servicesId"
],
"parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"location": "path",
"required": true,
"type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Service"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "migrateTraffic": {
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
"path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "request": {
+ "$ref": "Service"
+ },
"response": {
"$ref": "Operation"
},
@@ -436,26 +624,57 @@
"resources": {
"versions": {
"methods": {
- "list": {
- "description": "Lists the versions of a service.",
- "httpMethod": "GET",
- "id": "appengine.apps.services.versions.list",
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.delete",
"parameterOrder": [
"appsId",
- "servicesId"
+ "servicesId",
+ "versionsId"
],
"parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
"location": "path",
"required": true,
"type": "string"
},
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"view": {
"description": "Controls the set of fields returned in the List response.",
@@ -466,11 +685,17 @@
"location": "query",
"type": "string"
},
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query",
- "type": "integer"
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -498,18 +723,6 @@
"versionsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
@@ -524,6 +737,18 @@
],
"location": "query",
"type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
@@ -536,57 +761,30 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "create": {
- "description": "Deploys code and resource files to a new version.",
- "httpMethod": "POST",
- "id": "appengine.apps.services.versions.create",
+ "patch": {
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.versions.patch",
"parameterOrder": [
"appsId",
- "servicesId"
+ "servicesId",
+ "versionsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "patch": {
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "httpMethod": "PATCH",
- "id": "appengine.apps.services.versions.patch",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
"location": "path",
"required": true,
"type": "string"
@@ -596,11 +794,6 @@
"location": "path",
"required": true,
"type": "string"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "location": "query",
- "type": "string"
}
},
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
@@ -614,36 +807,32 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "delete": {
- "description": "Deletes an existing Version resource.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.versions.delete",
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
"parameterOrder": [
"appsId",
- "servicesId",
- "versionsId"
+ "servicesId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
"location": "path",
"required": true,
"type": "string"
},
"servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "description": "Part of `parent`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
"response": {
"$ref": "Operation"
},
@@ -665,33 +854,33 @@
"versionsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"servicesId": {
"description": "Part of `parent`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "versionsId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
"location": "path",
"required": true,
"type": "string"
},
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
"type": "string"
}
},
@@ -716,8 +905,8 @@
"instancesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
@@ -728,8 +917,8 @@
"required": true,
"type": "string"
},
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"location": "path",
"required": true,
"type": "string"
@@ -751,10 +940,10 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.versions.instances.delete",
+ "debug": {
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.instances.debug",
"parameterOrder": [
"appsId",
"servicesId",
@@ -762,32 +951,35 @@
"instancesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"location": "path",
"required": true,
"type": "string"
},
- "versionsId": {
+ "instancesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "instancesId": {
+ "versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -795,10 +987,10 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "debug": {
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "httpMethod": "POST",
- "id": "appengine.apps.services.versions.instances.debug",
+ "delete": {
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.instances.delete",
"parameterOrder": [
"appsId",
"servicesId",
@@ -806,8 +998,8 @@
"instancesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
@@ -818,8 +1010,8 @@
"required": true,
"type": "string"
},
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"location": "path",
"required": true,
"type": "string"
@@ -831,10 +1023,7 @@
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"response": {
"$ref": "Operation"
},
@@ -864,16 +1053,16 @@
"required": true,
"type": "string"
},
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
- "type": "string"
}
},
"path": "v1beta/apps/{appsId}/authorizedDomains",
@@ -888,37 +1077,42 @@
}
}
},
- "authorizedCertificates": {
+ "operations": {
"methods": {
"list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
"httpMethod": "GET",
- "id": "appengine.apps.authorizedCertificates.list",
+ "id": "appengine.apps.operations.list",
"parameterOrder": [
"appsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"pageSize": {
- "description": "Maximum results to return per page.",
+ "description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation collection.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "path": "v1beta/apps/{appsId}/operations",
"response": {
- "$ref": "ListAuthorizedCertificatesResponse"
+ "$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -927,156 +1121,88 @@
]
},
"get": {
- "description": "Gets the specified SSL certificate.",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
- "id": "appengine.apps.authorizedCertificates.get",
+ "id": "appengine.apps.operations.get",
"parameterOrder": [
"appsId",
- "authorizedCertificatesId"
+ "operationsId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "description": "Part of `name`. The name of the operation resource.",
"location": "path",
"required": true,
"type": "string"
},
- "authorizedCertificatesId": {
+ "operationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
- },
- "view": {
- "description": "Controls the set of fields returned in the GET response.",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "location": "query",
- "type": "string"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/operations/{operationsId}",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
- },
- "create": {
- "description": "Uploads the specified SSL certificate.",
- "httpMethod": "POST",
- "id": "appengine.apps.authorizedCertificates.create",
+ }
+ }
+ },
+ "domainMappings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.domainMappings.delete",
"parameterOrder": [
- "appsId"
+ "appsId",
+ "domainMappingsId"
],
"parameters": {
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "patch": {
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
- "httpMethod": "PATCH",
- "id": "appengine.apps.authorizedCertificates.patch",
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.list",
"parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
+ "appsId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
},
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.authorizedCertificates.delete",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "domainMappings": {
- "methods": {
- "list": {
- "description": "Lists the domain mappings on an application.",
- "httpMethod": "GET",
- "id": "appengine.apps.domainMappings.list",
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "location": "path",
- "required": true,
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
"type": "string"
},
"pageSize": {
@@ -1084,11 +1210,6 @@
"format": "int32",
"location": "query",
"type": "integer"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
- "type": "string"
}
},
"path": "v1beta/apps/{appsId}/domainMappings",
@@ -1133,32 +1254,6 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "create": {
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "httpMethod": "POST",
- "id": "appengine.apps.domainMappings.create",
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/domainMappings",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"patch": {
"description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
"httpMethod": "PATCH",
@@ -1168,12 +1263,6 @@
"domainMappingsId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"domainMappingsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
@@ -1182,126 +1271,52 @@
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
"location": "query",
"type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.domainMappings.delete",
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "location": "path",
- "required": true,
- "type": "string"
},
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "id": "appengine.apps.locations.list",
+ },
+ "create": {
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.domainMappings.create",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
- },
- "filter": {
- "description": "The standard list filter.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "location": "query",
- "type": "string"
}
},
- "path": "v1beta/apps/{appsId}/locations",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "id": "appengine.apps.locations.get",
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
},
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
"response": {
- "$ref": "Location"
+ "$ref": "Operation"
},
"scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
]
}
}
@@ -1309,232 +1324,284 @@
}
}
},
- "revision": "20170324",
+ "revision": "20170405",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "id": "ListOperationsResponse",
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "id": "Version",
"properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
+ "createTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
+ },
+ "inboundServices": {
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
"items": {
- "$ref": "Operation"
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ],
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "id": "Operation",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
+ },
+ "defaultExpiration": {
+ "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "format": "google-duration",
"type": "string"
},
- "metadata": {
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "Library"
+ },
+ "type": "array"
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "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 driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "envVariables": {
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "type": "string"
},
- "description": "Service-specific metadata associated with the 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.",
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
"type": "object"
},
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
+ "livenessCheck": {
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
},
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
- "response": {
+ "betaSettings": {
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "type": "string"
},
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
"type": "object"
- }
- },
- "type": "object"
- },
- "Status": {
- "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 designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe 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. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in 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.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily 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 mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return 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 multiple 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 operation 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 for security/privacy reasons.",
- "id": "Status",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
},
- "message": {
- "description": "A developer-facing error message, which should 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.",
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
"type": "string"
},
- "details": {
- "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
"items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "$ref": "UrlMap"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "id": "Application",
- "properties": {
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
},
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "diskUsageBytes": {
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "format": "int64",
"type": "string"
},
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
},
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "readinessCheck": {
+ "$ref": "ReadinessCheck",
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
+ },
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
"type": "string"
},
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "apiConfig": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
"type": "string"
},
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"servingStatus": {
- "description": "Serving status of this application.",
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
"enum": [
- "UNSPECIFIED",
+ "SERVING_STATUS_UNSPECIFIED",
"SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
+ "STOPPED"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
],
"type": "string"
},
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
}
},
"type": "object"
},
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "id": "UrlDispatchRule",
+ "RepairApplicationRequest": {
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "id": "RepairApplicationRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "id": "CertificateRawData",
"properties": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>",
"type": "string"
},
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly",
"type": "string"
}
},
"type": "object"
},
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "id": "IdentityAwareProxy",
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "id": "FileInfo",
"properties": {
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
"type": "string"
},
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
"type": "string"
},
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.",
"type": "string"
}
},
"type": "object"
},
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "id": "RepairApplicationRequest",
- "type": "object"
- },
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "id": "ListServicesResponse",
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
"properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "items": {
- "$ref": "Service"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
"type": "object"
},
- "Service": {
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "id": "Service",
- "properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataExperimental",
+ "properties": {
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
"type": "string"
},
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthorizedDomain": {
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "id": "AuthorizedDomain",
+ "properties": {
"id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
"type": "string"
},
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
@@ -1551,6 +1618,12 @@
"IP",
"RANDOM"
],
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ],
"type": "string"
},
"allocations": {
@@ -1564,220 +1637,275 @@
},
"type": "object"
},
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "id": "ListVersionsResponse",
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
"properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
- "$ref": "Version"
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "Version": {
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "id": "Version",
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
"properties": {
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "basicScaling": {
- "$ref": "BasicScaling",
- "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 driven by user activity."
- },
- "manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
- },
- "inboundServices": {
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
+ "services": {
+ "description": "The services belonging to the requested application.",
"items": {
- "enum": [
- "INBOUND_SERVICE_UNSPECIFIED",
- "INBOUND_SERVICE_MAIL",
- "INBOUND_SERVICE_MAIL_BOUNCE",
- "INBOUND_SERVICE_XMPP_ERROR",
- "INBOUND_SERVICE_XMPP_MESSAGE",
- "INBOUND_SERVICE_XMPP_SUBSCRIBE",
- "INBOUND_SERVICE_XMPP_PRESENCE",
- "INBOUND_SERVICE_CHANNEL_PRESENCE",
- "INBOUND_SERVICE_WARMUP"
- ],
- "type": "string"
+ "$ref": "Service"
},
"type": "array"
},
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "id": "Resources",
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
},
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
},
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
},
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "id": "Deployment",
+ "properties": {
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
},
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
},
- "betaSettings": {
+ "files": {
"additionalProperties": {
- "type": "string"
+ "$ref": "FileInfo"
},
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
"type": "object"
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "servingStatus": {
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "type": "string"
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
+ }
+ },
+ "type": "object"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "id": "Volume",
+ "properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
"type": "string"
},
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "type": "string"
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
},
- "diskUsageBytes": {
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "format": "int64",
+ "name": {
+ "description": "Unique name for the volume.",
"type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ }
+ },
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
"items": {
- "$ref": "ErrorHandler"
+ "$ref": "Instance"
},
"type": "array"
},
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "id": "ListDomainMappingsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
"items": {
- "$ref": "Library"
+ "$ref": "DomainMapping"
},
"type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
},
- "apiConfig": {
- "$ref": "ApiConfigHandler",
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
},
- "envVariables": {
- "additionalProperties": {
- "type": "string"
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
},
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
+ "type": "array"
},
- "defaultExpiration": {
- "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "id": "ListAuthorizedDomainsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
},
- "healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
- },
- "readinessCheck": {
- "$ref": "ReadinessCheck",
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
- },
- "livenessCheck": {
- "$ref": "LivenessCheck",
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "id": "DomainMapping",
+ "properties": {
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
"type": "string"
},
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
},
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
"type": "string"
},
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ "resourceRecords": {
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
}
},
"type": "object"
},
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
"AutomaticScaling": {
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"id": "AutomaticScaling",
"properties": {
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
"format": "int32",
"type": "integer"
},
@@ -1786,225 +1914,204 @@
"format": "int32",
"type": "integer"
},
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
"format": "int32",
"type": "integer"
},
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
"format": "int32",
"type": "integer"
},
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
"type": "string"
},
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
"diskUtilization": {
"$ref": "DiskUtilization",
"description": "Target scaling by disk usage."
},
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- }
- },
- "type": "object"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "id": "CpuUtilization",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
"type": "string"
},
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "id": "RequestUtilization",
- "properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
"format": "int32",
"type": "integer"
},
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
}
},
"type": "object"
},
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "id": "DiskUtilization",
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "id": "ZipInfo",
"properties": {
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
+ "filesCount": {
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
"format": "int32",
"type": "integer"
},
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.",
+ "type": "string"
}
},
"type": "object"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "id": "NetworkUtilization",
+ "AuthorizedCertificate": {
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "id": "AuthorizedCertificate",
"properties": {
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
},
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
},
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
+ "visibleDomainMappings": {
+ "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
+ "expireTime": {
+ "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
+ },
+ "domainMappingsCount": {
+ "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly",
"format": "int32",
"type": "integer"
+ },
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
},
- "BasicScaling": {
- "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 driven by user activity.",
- "id": "BasicScaling",
+ "ResourceRecord": {
+ "description": "A DNS resource record.",
+ "id": "ResourceRecord",
"properties": {
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
"type": "string"
},
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource record type. Example: AAAA.",
+ "enum": [
+ "A",
+ "AAAA",
+ "CNAME"
+ ],
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "id": "ManualScaling",
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
"properties": {
- "instances": {
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "format": "int32",
- "type": "integer"
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
}
},
"type": "object"
},
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "id": "Network",
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
"properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
"items": {
- "type": "string"
+ "$ref": "Location"
},
"type": "array"
},
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
- "Resources": {
- "description": "Machine resources for a version.",
- "id": "Resources",
+ "ContainerInfo": {
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "id": "ContainerInfo",
"properties": {
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "volumes": {
- "description": "User specified volumes.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
}
},
"type": "object"
},
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "id": "Volume",
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "id": "RequestUtilization",
"properties": {
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
},
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
- "type": "number"
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -2013,21 +2120,31 @@
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"id": "UrlMap",
"properties": {
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
},
"staticFiles": {
"$ref": "StaticFilesHandler",
"description": "Returns the contents of a file, such as an image, as the response."
},
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
+ "redirectHttpResponseCode": {
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "type": "string"
},
"securityLevel": {
"description": "Security (HTTPS) enforcement for this URL.",
@@ -2038,15 +2155,12 @@
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
],
- "type": "string"
- },
- "login": {
- "description": "Level of login required to access this resource.",
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
],
"type": "string"
},
@@ -2057,127 +2171,77 @@
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
"type": "string"
},
- "redirectHttpResponseCode": {
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource.",
"enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
],
"type": "string"
}
},
"type": "object"
},
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "id": "StaticFilesHandler",
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "id": "EndpointsApiService",
"properties": {
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
"type": "string"
},
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "id": "ScriptHandler",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "id": "ApiEndpointHandler",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
"type": "string"
}
},
"type": "object"
},
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "id": "ErrorHandler",
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
"properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
"enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
],
"type": "string"
},
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "id": "Library",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "id": "ApiConfigHandler",
- "properties": {
"authFailAction": {
"description": "Action to take when users access resources that require authentication. Defaults to redirect.",
"enum": [
@@ -2185,6 +2249,15 @@
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
},
"login": {
@@ -2195,20 +2268,11 @@
"LOGIN_ADMIN",
"LOGIN_REQUIRED"
],
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
],
"type": "string"
},
@@ -2219,315 +2283,296 @@
},
"type": "object"
},
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "id": "HealthCheck",
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
"properties": {
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
},
- "checkInterval": {
- "description": "Interval between health checks.",
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"type": "string"
},
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "type": "string"
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the 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.",
+ "type": "object"
}
},
"type": "object"
},
- "ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "id": "ReadinessCheck",
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "id": "StaticFilesHandler",
"properties": {
- "path": {
- "description": "The request path.",
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
"type": "string"
},
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
},
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
},
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
},
- "checkInterval": {
- "description": "Interval between health checks.",
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
"type": "string"
},
- "timeout": {
- "description": "Time before the check is considered failed.",
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
"type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
}
},
"type": "object"
},
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "id": "LivenessCheck",
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "id": "DiskUtilization",
"properties": {
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
"type": "integer"
},
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
"type": "integer"
},
- "checkInterval": {
- "description": "Interval between health checks.",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "type": "string"
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
},
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "type": "string"
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "id": "Deployment",
+ "BasicScaling": {
+ "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 driven by user activity.",
+ "id": "BasicScaling",
"properties": {
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
},
- "container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
},
- "zip": {
- "$ref": "ZipInfo",
- "description": "The zip file for this deployment, if this is a zip deployment."
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "id": "FileInfo",
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
"properties": {
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.",
+ "enabled": {
+ "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
+ "type": "boolean"
+ },
+ "oauth2ClientSecret": {
+ "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
"type": "string"
},
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
"type": "string"
},
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "id": "ContainerInfo",
+ "Status": {
+ "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 designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in 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.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily 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 mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.\nBatch 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.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
"properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "details": {
+ "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should 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.",
"type": "string"
}
},
"type": "object"
},
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "id": "ZipInfo",
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "id": "ManualScaling",
"properties": {
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.",
- "type": "string"
- },
- "filesCount": {
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "instances": {
+ "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "id": "EndpointsApiService",
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Service": {
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "id": "Service",
"properties": {
"name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ },
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "id": "ListInstancesResponse",
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
- "$ref": "Instance"
+ "$ref": "Operation"
},
"type": "array"
},
"nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "id": "Instance",
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
"properties": {
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
"type": "string"
},
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
},
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
},
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "id": "DebugInstanceRequest",
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "id": "ListAuthorizedDomainsResponse",
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "id": "ListAuthorizedCertificatesResponse",
"properties": {
- "domains": {
- "description": "The authorized domains belonging to the user.",
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
"items": {
- "$ref": "AuthorizedDomain"
+ "$ref": "AuthorizedCertificate"
},
"type": "array"
},
@@ -2538,198 +2583,309 @@
},
"type": "object"
},
- "AuthorizedDomain": {
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "id": "AuthorizedDomain",
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
"properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "id": "ListAuthorizedCertificatesResponse",
- "properties": {
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "items": {
- "$ref": "AuthorizedCertificate"
- },
- "type": "array"
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "type": "string"
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
"type": "string"
}
},
"type": "object"
},
- "AuthorizedCertificate": {
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
- "id": "AuthorizedCertificate",
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "id": "SslSettings",
"properties": {
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
"type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
"type": "string"
},
"type": "array"
},
- "expireTime": {
- "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
},
- "visibleDomainMappings": {
- "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
},
- "domainMappingsCount": {
- "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "id": "CertificateRawData",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:\n-----BEGIN CERTIFICATE----- -----END CERTIFICATE-----",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
"type": "string"
},
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:\n-----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----\n@InputOnly",
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.",
- "id": "Empty",
- "type": "object"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "id": "ListDomainMappingsResponse",
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "id": "Network",
"properties": {
- "domainMappings": {
- "description": "The domain mappings for the application.",
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
"items": {
- "$ref": "DomainMapping"
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
"type": "string"
}
},
"type": "object"
},
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "id": "DomainMapping",
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application",
"properties": {
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
"name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
"id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
"type": "string"
},
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
},
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "items": {
- "$ref": "ResourceRecord"
- },
- "type": "array"
+ "locationId": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "servingStatus": {
+ "description": "Serving status of this application.",
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
},
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "id": "SslSettings",
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
"properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "id": "ResourceRecord",
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "id": "LivenessCheck",
"properties": {
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
"type": "string"
},
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
"type": "string"
},
- "type": {
- "description": "Resource record type. Example: AAAA.",
- "enum": [
- "A",
- "AAAA",
- "CNAME"
- ],
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
"type": "string"
- }
- },
- "type": "object"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "id": "ListLocationsResponse",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "path": {
+ "description": "The request path.",
"type": "string"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
}
},
"type": "object"
@@ -2738,6 +2894,13 @@
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
@@ -2746,13 +2909,6 @@
"description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
},
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- },
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -2764,143 +2920,135 @@
},
"type": "object"
},
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataExperimental",
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "id": "NetworkUtilization",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
},
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadata",
+ "HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "id": "HealthCheck",
"properties": {
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
"type": "string"
},
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
"type": "string"
}
},
"type": "object"
},
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta5",
+ "ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "id": "ReadinessCheck",
"properties": {
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
"type": "string"
},
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "path": {
+ "description": "The request path.",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
"type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
}
},
"type": "object"
},
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta",
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
"type": "object"
},
- "OperationMetadataV1": {
+ "OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1",
+ "id": "OperationMetadataV1Beta5",
"properties": {
"method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
},
"insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
"endTime": {
- "description": "Time that this operation completed.@OutputOnly",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
"user": {
@@ -2910,32 +3058,6 @@
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "id": "LocationMetadata",
- "properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis_beta/adexchangebuyer2__v2beta1.json ('k') | discovery/googleapis_beta/appengine__v1beta4.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698