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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis_beta/appengine__v1beta.json

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 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
« no previous file with comments | « discovery/googleapis_beta/adexchangebuyer2__v2beta1.json ('k') | discovery/googleapis_beta/appengine__v1beta4.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis_beta/appengine__v1beta.json
diff --git a/discovery/googleapis_beta/appengine__v1beta.json b/discovery/googleapis_beta/appengine__v1beta.json
index 614a62e604787169b02a0df7aef6514fe07a2442..85de1accac239360177cd1548f9052785f3559c5 100644
--- a/discovery/googleapis_beta/appengine__v1beta.json
+++ b/discovery/googleapis_beta/appengine__v1beta.json
@@ -2,14 +2,14 @@
"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.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"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"
}
}
}
@@ -30,16 +30,6 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
"callback": {
"description": "JSONP",
"location": "query",
@@ -95,13 +85,13 @@
"location": "query",
"type": "boolean"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
@@ -115,35 +105,46 @@
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
+ },
+ "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\").",
+ "location": "query",
+ "type": "string"
}
},
"protocol": "rest",
"resources": {
"apps": {
"methods": {
- "get": {
- "description": "Gets information about an application.",
- "httpMethod": "GET",
- "id": "appengine.apps.get",
+ "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",
+ "id": "appengine.apps.repair",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}:repair",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
"response": {
- "$ref": "Application"
+ "$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"
]
},
"patch": {
@@ -154,17 +155,17 @@
"appsId"
],
"parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- },
"appsId": {
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1beta/apps/{appsId}",
@@ -178,41 +179,40 @@
"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",
- "id": "appengine.apps.repair",
+ "get": {
+ "description": "Gets information about an application.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.get",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}:repair",
+ "path": "v1beta/apps/{appsId}",
+ "response": {
+ "$ref": "Application"
+ },
+ "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": "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": "RepairApplicationRequest"
+ "$ref": "Application"
},
"response": {
"$ref": "Operation"
@@ -223,98 +223,126 @@
}
},
"resources": {
- "locations": {
+ "services": {
"methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "id": "appengine.apps.locations.list",
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
"parameterOrder": [
- "appsId"
+ "appsId",
+ "servicesId"
],
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
+ "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"
+ ]
+ },
+ "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": "integer"
+ "type": "boolean"
},
- "filter": {
- "description": "The standard list filter.",
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
"location": "query",
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "The standard list page token.",
- "location": "query",
+ "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}/locations",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "request": {
+ "$ref": "Service"
+ },
"response": {
- "$ref": "ListLocationsResponse"
+ "$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"
]
},
"get": {
- "description": "Get information about a location.",
+ "description": "Gets the current configuration of the specified service.",
"httpMethod": "GET",
- "id": "appengine.apps.locations.get",
+ "id": "appengine.apps.services.get",
"parameterOrder": [
"appsId",
- "locationsId"
+ "servicesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "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}/locations/{locationsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
"response": {
- "$ref": "Location"
+ "$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"
]
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
+ },
"list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
+ "description": "Lists all the services in the application.",
"httpMethod": "GET",
- "id": "appengine.apps.authorizedCertificates.list",
+ "id": "appengine.apps.services.list",
"parameterOrder": [
"appsId"
],
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"location": "query",
- "type": "integer"
+ "type": "string"
},
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -322,185 +350,608 @@
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
"location": "query",
- "type": "string"
+ "type": "integer"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "path": "v1beta/apps/{appsId}/services",
"response": {
- "$ref": "ListAuthorizedCertificatesResponse"
+ "$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 specified SSL certificate.",
- "httpMethod": "GET",
- "id": "appengine.apps.authorizedCertificates.get",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls the set of fields returned in the GET response.",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "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 `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"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "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"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "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"
+ ]
+ },
+ "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",
+ "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"
+ },
+ "versionsId": {
+ "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.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "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/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "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": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "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",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "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/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "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/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets instance information.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "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/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "response": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedDomains.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"location": "query",
"type": "string"
},
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "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.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedDomains",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "ListAuthorizedDomainsResponse"
},
"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 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",
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "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.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
"parameterOrder": [
"appsId",
- "authorizedCertificatesId"
+ "operationsId"
],
"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/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"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
+ "path": "v1beta/apps/{appsId}/operations/{operationsId}",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "Operation"
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "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",
+ "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
"parameterOrder": [
"appsId"
],
"parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ },
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. The name of the operation's parent resource.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
+ "path": "v1beta/apps/{appsId}/operations",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "ListOperationsResponse"
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
- },
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.authorizedCertificates.delete",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
+ }
+ }
+ },
+ "domainMappings": {
+ "methods": {
+ "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`. 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`.",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- }
- }
- },
- "services": {
- "methods": {
+ },
"delete": {
- "description": "Deletes the specified service and all enclosed versions.",
+ "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.services.delete",
+ "id": "appengine.apps.domainMappings.delete",
"parameterOrder": [
"appsId",
- "servicesId"
+ "domainMappingsId"
],
"parameters": {
- "servicesId": {
+ "domainMappingsId": {
"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.",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"response": {
"$ref": "Operation"
},
@@ -508,67 +959,70 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "list": {
- "description": "Lists all the services in the application.",
- "httpMethod": "GET",
- "id": "appengine.apps.services.list",
+ "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",
+ "id": "appengine.apps.domainMappings.patch",
"parameterOrder": [
- "appsId"
+ "appsId",
+ "domainMappingsId"
],
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "domainMappingsId": {
+ "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.",
+ "format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
"response": {
- "$ref": "ListServicesResponse"
+ "$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"
]
},
"get": {
- "description": "Gets the current configuration of the specified service.",
+ "description": "Gets the specified domain mapping.",
"httpMethod": "GET",
- "id": "appengine.apps.services.get",
+ "id": "appengine.apps.domainMappings.get",
"parameterOrder": [
"appsId",
- "servicesId"
+ "domainMappingsId"
],
"parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
"location": "path",
"required": true,
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"response": {
- "$ref": "Service"
+ "$ref": "DomainMapping"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -576,136 +1030,99 @@
"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",
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.list",
"parameterOrder": [
- "appsId",
- "servicesId"
+ "appsId"
],
"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",
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"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.",
+ "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.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "request": {
- "$ref": "Service"
- },
+ "path": "v1beta/apps/{appsId}/domainMappings",
"response": {
- "$ref": "Operation"
+ "$ref": "ListDomainMappingsResponse"
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
- },
+ }
+ },
+ "firewall": {
"resources": {
- "versions": {
+ "ingressRules": {
"methods": {
- "delete": {
- "description": "Deletes an existing Version resource.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.versions.delete",
+ "create": {
+ "description": "Creates a firewall rule for the application.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.create",
"parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
+ "appsId"
],
"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/versions/v1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "request": {
+ "$ref": "FirewallRule"
+ },
"response": {
- "$ref": "Operation"
+ "$ref": "FirewallRule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "list": {
- "description": "Lists the versions of a service.",
+ "get": {
+ "description": "Gets the specified firewall rule.",
"httpMethod": "GET",
- "id": "appengine.apps.services.versions.list",
+ "id": "appengine.apps.firewall.ingressRules.get",
"parameterOrder": [
"appsId",
- "servicesId"
+ "ingressRulesId"
],
"parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
"location": "path",
"required": true,
"type": "string"
},
- "appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"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"
- },
- "view": {
- "description": "Controls the set of fields returned in the List response.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "location": "query",
- "type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"response": {
- "$ref": "ListVersionsResponse"
+ "$ref": "FirewallRule"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -713,438 +1130,214 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "httpMethod": "GET",
- "id": "appengine.apps.services.versions.get",
+ "patch": {
+ "description": "Updates the specified firewall rule.",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.firewall.ingressRules.patch",
"parameterOrder": [
"appsId",
- "servicesId",
- "versionsId"
+ "ingressRulesId"
],
"parameters": {
- "versionsId": {
+ "ingressRulesId": {
"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",
- "FULL"
- ],
+ "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 requested. Example: apps/myapp/services/default/versions/v1.",
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "request": {
+ "$ref": "FirewallRule"
+ },
"response": {
- "$ref": "Version"
+ "$ref": "FirewallRule"
},
"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"
]
},
- "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",
+ "batchUpdate": {
+ "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
"parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
+ "appsId"
],
"parameters": {
- "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/versions/1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
"request": {
- "$ref": "Version"
+ "$ref": "BatchUpdateIngressRulesRequest"
},
"response": {
- "$ref": "Operation"
+ "$ref": "BatchUpdateIngressRulesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "create": {
- "description": "Deploys code and resource files to a new version.",
- "httpMethod": "POST",
- "id": "appengine.apps.services.versions.create",
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.firewall.ingressRules.delete",
"parameterOrder": [
"appsId",
- "servicesId"
+ "ingressRulesId"
],
"parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
"appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "request": {
- "$ref": "Version"
- },
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"response": {
- "$ref": "Operation"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.versions.instances.delete",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "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/instances/instance-1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ },
+ "list": {
+ "description": "Lists the firewall rules of an application.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
},
- "list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "httpMethod": "GET",
- "id": "appengine.apps.services.versions.instances.list",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "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"
- },
- "versionsId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "get": {
- "description": "Gets instance information.",
- "httpMethod": "GET",
- "id": "appengine.apps.services.versions.instances.get",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "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/instances/instance-1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "response": {
- "$ref": "Instance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
- "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",
- "versionsId",
- "instancesId"
- ],
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "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/instances/instance-1.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "matchingAddress": {
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "location": "query",
+ "type": "string"
}
- }
+ },
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
}
}
},
- "authorizedDomains": {
+ "locations": {
"methods": {
- "list": {
- "description": "Lists all domains the user is authorized to administer.",
+ "get": {
+ "description": "Get information about a location.",
"httpMethod": "GET",
- "id": "appengine.apps.authorizedDomains.list",
+ "id": "appengine.apps.locations.get",
"parameterOrder": [
- "appsId"
+ "appsId",
+ "locationsId"
],
"parameters": {
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. Resource name for the location.",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
"type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query",
- "type": "integer"
}
},
- "path": "v1beta/apps/{appsId}/authorizedDomains",
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
"response": {
- "$ref": "ListAuthorizedDomainsResponse"
+ "$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
- }
- }
- },
- "operations": {
- "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "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": {
- "filter": {
- "description": "The standard list filter.",
+ "pageToken": {
+ "description": "The standard list page token.",
"location": "query",
"type": "string"
},
"appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
+ "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.",
- "location": "query",
- "type": "string"
- },
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
- }
- },
- "path": "v1beta/apps/{appsId}/operations",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "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 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.operations.get",
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "location": "path",
- "required": true,
- "type": "string"
},
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "path": "v1beta/apps/{appsId}/locations",
"response": {
- "$ref": "Operation"
+ "$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -1154,69 +1347,81 @@
}
}
},
- "domainMappings": {
+ "authorizedCertificates": {
"methods": {
- "list": {
- "description": "Lists the domain mappings on an application.",
- "httpMethod": "GET",
- "id": "appengine.apps.domainMappings.list",
+ "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",
"parameterOrder": [
- "appsId"
+ "appsId",
+ "authorizedCertificatesId"
],
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
+ "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": "integer"
+ "type": "string"
},
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "location": "query",
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
"response": {
- "$ref": "ListDomainMappingsResponse"
+ "$ref": "AuthorizedCertificate"
},
"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"
]
},
"get": {
- "description": "Gets the specified domain mapping.",
+ "description": "Gets the specified SSL certificate.",
"httpMethod": "GET",
- "id": "appengine.apps.domainMappings.get",
+ "id": "appengine.apps.authorizedCertificates.get",
"parameterOrder": [
"appsId",
- "domainMappingsId"
+ "authorizedCertificatesId"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
},
- "domainMappingsId": {
- "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"
+ },
+ "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}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"response": {
- "$ref": "DomainMapping"
+ "$ref": "AuthorizedCertificate"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -1224,49 +1429,46 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
- "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",
- "id": "appengine.apps.domainMappings.patch",
+ "list": {
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.list",
"parameterOrder": [
- "appsId",
- "domainMappingsId"
+ "appsId"
],
"parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"location": "query",
"type": "string"
},
"appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
},
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
}
},
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "request": {
- "$ref": "DomainMapping"
- },
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
"response": {
- "$ref": "Operation"
+ "$ref": "ListAuthorizedCertificatesResponse"
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "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": "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.",
+ "description": "Uploads the specified SSL certificate.",
"httpMethod": "POST",
- "id": "appengine.apps.domainMappings.create",
+ "id": "appengine.apps.authorizedCertificates.create",
"parameterOrder": [
"appsId"
],
@@ -1278,42 +1480,42 @@
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
"request": {
- "$ref": "DomainMapping"
+ "$ref": "AuthorizedCertificate"
},
"response": {
- "$ref": "Operation"
+ "$ref": "AuthorizedCertificate"
},
"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.",
+ "description": "Deletes the specified SSL certificate.",
"httpMethod": "DELETE",
- "id": "appengine.apps.domainMappings.delete",
+ "id": "appengine.apps.authorizedCertificates.delete",
"parameterOrder": [
"appsId",
- "domainMappingsId"
+ "authorizedCertificatesId"
],
"parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
"location": "path",
"required": true,
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"response": {
- "$ref": "Operation"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
@@ -1321,873 +1523,1081 @@
}
}
}
- }
- }
- },
- "revision": "20170601",
- "rootUrl": "https://appengine.googleapis.com/",
- "schemas": {
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "id": "ListDomainMappingsResponse",
+ }
+ }
+ },
+ "revision": "20170626",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "schemas": {
+ "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.",
+ "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",
+ "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\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "id": "RequestUtilization",
+ "properties": {
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UrlMap": {
+ "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": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "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."
+ },
+ "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"
},
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "items": {
- "$ref": "DomainMapping"
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "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"
+ },
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "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": {
+ "$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": [
+ "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"
+ },
+ "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": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "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"
},
- "type": "array"
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
}
},
"type": "object"
},
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Alpha",
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
"properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "enum": [
+ "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"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "url": {
+ "description": "URL to serve the endpoint at.",
"type": "string"
},
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "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"
},
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "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"
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "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",
+ "properties": {
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "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"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "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"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "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"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
}
},
"type": "object"
},
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "id": "UrlDispatchRule",
+ "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": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "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"
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
},
- "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.",
+ "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"
}
},
"type": "object"
},
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "id": "ListVersionsResponse",
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "id": "DiskUtilization",
"properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "id": "ListAuthorizedDomainsResponse",
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
"type": "string"
},
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "items": {
- "$ref": "AuthorizedDomain"
- },
- "type": "array"
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "id": "DomainMapping",
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
"properties": {
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"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"
+ "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"
},
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "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"
},
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- }
- },
- "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"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "id": "ApiEndpointHandler",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
"type": "string"
}
},
"type": "object"
},
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "id": "AutomaticScaling",
+ "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 that 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.\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": {
- "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"
+ "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"
},
- "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.",
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"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.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
- "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",
+ "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"
- },
- "standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
+ }
+ },
+ "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",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
},
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"type": "object"
},
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "id": "ZipInfo",
+ "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": {
- "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"
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
},
- "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>'.",
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"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",
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"properties": {
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
},
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
- "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",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
- "type": "string"
+ "$ref": "Operation"
},
"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",
- "format": "google-datetime",
+ }
+ },
+ "type": "object"
+ },
+ "FirewallRule": {
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "id": "FirewallRule",
+ "properties": {
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
"type": "string"
},
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "sourceRange": {
+ "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
"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",
+ "priority": {
+ "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
"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",
+ "action": {
+ "description": "The action to take on matched requests.",
+ "enum": [
+ "UNSPECIFIED_ACTION",
+ "ALLOW",
+ "DENY"
+ ],
+ "enumDescriptions": [
+ "",
+ "Matching requests are allowed.",
+ "Matching requests are denied."
+ ],
"type": "string"
}
},
"type": "object"
},
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "id": "ResourceRecord",
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
"properties": {
- "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."
- ],
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"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).",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
"type": "string"
},
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "id": "Library",
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "id": "ListAuthorizedCertificatesResponse",
"properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
},
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "id": "ListLocationsResponse",
+ "FeatureSettings": {
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "id": "FeatureSettings",
"properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
+ "splitHealthChecks": {
+ "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
- "$ref": "Location"
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "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"
+ },
+ "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.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"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",
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "id": "SslSettings",
"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\"",
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
"type": "string"
}
},
"type": "object"
},
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "id": "RequestUtilization",
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
"properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
},
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
+ "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"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
}
},
"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",
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "id": "Network",
"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\"",
+ "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"
},
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
},
- "UrlMap": {
- "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",
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 19",
+ "id": "Application",
"properties": {
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "enum": [
- "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."
- ],
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
"type": "string"
},
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "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."
- ],
+ "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.",
"type": "string"
},
- "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.",
+ "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"
},
- "login": {
- "description": "Level of login required to access this resource.",
+ "servingStatus": {
+ "description": "Serving status of this application.",
"enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
],
"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."
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
],
"type": "string"
},
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
},
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
},
- "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."
- ],
+ "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"
+ },
+ "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 Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "id": "ApiConfigHandler",
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
"properties": {
- "login": {
- "description": "Level of login required to access this resource. Defaults to optional.",
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
"enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
],
"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"
},
- "url": {
- "description": "URL to serve the endpoint at.",
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "enum": [
- "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."
- ],
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "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."
- ],
+ "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"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
},
- "script": {
- "description": "Path to the script from the application root directory.",
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"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": {
- "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"
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
},
- "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"
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
- "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"
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
"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.",
+ "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"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "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"
}
},
"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",
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "id": "LivenessCheck",
"properties": {
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
"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.",
+ "description": "The request path.",
"type": "string"
},
- "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"
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
},
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
},
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "checkInterval": {
+ "description": "Interval between health checks.",
"format": "google-duration",
"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 considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
},
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "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",
+ "BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "id": "BatchUpdateIngressRulesRequest",
"properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "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"
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "id": "DiskUtilization",
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "id": "NetworkUtilization",
"properties": {
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
"format": "int32",
"type": "integer"
},
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
"format": "int32",
"type": "integer"
},
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
"format": "int32",
"type": "integer"
},
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "id": "CpuUtilization",
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
"properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
},
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "id": "IdentityAwareProxy",
- "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"
- },
- "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",
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
},
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
},
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "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:\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 that 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.\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",
+ "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": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
"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.",
+ "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"
},
- "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"
- }
- },
- "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",
- "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",
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
"type": "integer"
- }
- },
- "type": "object"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "id": "LocationMetadata",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
},
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
"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",
+ "ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "id": "ReadinessCheck",
"properties": {
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
},
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
"type": "string"
},
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
"type": "string"
- }
- },
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "id": "ListOperationsResponse",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
"type": "string"
},
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "appStartTimeout": {
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
}
},
"type": "object"
},
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadata",
+ "StandardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "id": "StandardSchedulerSettings",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
+ "targetThroughputUtilization": {
+ "description": "Target throughput utilization ratio to maintain when scaling",
+ "format": "double",
+ "type": "number"
},
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "maxInstances": {
+ "description": "Maximum number of instances for an app version. Set to a non-positive value (0 by convention) to disable max_instances configuration.",
+ "format": "int32",
+ "type": "integer"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
+ "minInstances": {
+ "description": "Minimum number of instances for an app version. Set to a non-positive value (0 by convention) to disable min_instances configuration.",
+ "format": "int32",
+ "type": "integer"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "targetCpuUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "id": "ListAuthorizedCertificatesResponse",
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "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"
- },
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "items": {
- "$ref": "AuthorizedCertificate"
- },
- "type": "array"
}
},
"type": "object"
},
- "OperationMetadataV1": {
+ "OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1",
+ "id": "OperationMetadataV1Beta5",
"properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
@@ -2199,945 +2609,847 @@
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "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.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "id": "SslSettings",
- "properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "id": "ErrorHandler",
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "id": "Version",
"properties": {
- "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"
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
},
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
+ "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."
},
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "id": "Network",
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "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."
},
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
"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"
+ "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."
},
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "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"
- }
- },
- "type": "object"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 19",
- "id": "Application",
- "properties": {
- "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",
+ },
+ "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": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
+ "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"
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.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.",
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref",
"type": "string"
},
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "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",
+ "createTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
- "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",
+ "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": "UrlDispatchRule"
+ "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"
},
- "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 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.",
- "type": "string"
+ "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"
},
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
+ "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"
- }
- },
- "type": "object"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "id": "Instance",
- "properties": {
- "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"
+ "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"
},
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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"
},
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "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."
},
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
},
"id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "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"
},
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
},
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
+ "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."
},
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
},
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
"type": "string"
},
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
+ "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"
},
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
+ "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"
+ },
+ "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."
}
},
"type": "object"
},
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "id": "LivenessCheck",
+ "RepairApplicationRequest": {
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "id": "RepairApplicationRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "BuildInfo": {
+ "description": "Google Cloud Container Builder build information.",
+ "id": "BuildInfo",
"properties": {
- "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"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "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"
- },
- "path": {
- "description": "The request path.",
+ "cloudBuildId": {
+ "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
"type": "string"
}
},
"type": "object"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "id": "Location",
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "id": "CertificateRawData",
"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\"",
+ "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"
},
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
+ "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"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
}
},
"type": "object"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "id": "NetworkUtilization",
+ "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": {
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
},
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
},
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
+ "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"
},
- "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",
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
"properties": {
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "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",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
"type": "object"
},
- "ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "id": "ReadinessCheck",
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataExperimental",
"properties": {
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
"type": "string"
},
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
},
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
"type": "string"
},
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
},
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "id": "DebugInstanceRequest",
+ "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": {
- "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).",
+ "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"
},
- "StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "id": "StandardSchedulerSettings",
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "id": "TrafficSplit",
"properties": {
- "targetThroughputUtilization": {
- "description": "Target throughput utilization ratio to maintain when scaling",
- "format": "double",
- "type": "number"
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
},
- "targetCpuUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling.",
- "format": "double",
- "type": "number"
+ "shardBy": {
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "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"
}
},
"type": "object"
},
- "OperationMetadataV1Beta5": {
+ "OperationMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta5",
+ "id": "OperationMetadataV1Beta",
"properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "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": "Timestamp that this operation completed.@OutputOnly",
+ "description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
},
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "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",
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "id": "ListIngressRulesResponse",
"properties": {
- "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",
+ "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."
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "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",
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"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."
- },
- "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"
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "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."
},
- "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"
+ "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."
},
- "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"
- ],
- "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"
+ "build": {
+ "$ref": "BuildInfo",
+ "description": "Google Cloud Container Builder build information."
},
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "id": "Resources",
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
},
- "runtimeApiVersion": {
- "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref",
- "type": "string"
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
},
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
},
- "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."
- ],
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "id": "BatchUpdateIngressRulesResponse",
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this 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": "FirewallRule"
},
"type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "id": "Volume",
+ "properties": {
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
},
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ }
+ },
+ "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"
},
- "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",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
- },
- "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.",
+ }
+ },
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "id": "ListDomainMappingsResponse",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
"items": {
- "$ref": "Library"
+ "$ref": "DomainMapping"
},
"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.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"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": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @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-\".",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
"type": "string"
},
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "envVariables": {
- "additionalProperties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
"type": "string"
},
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "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."
- },
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
+ "type": "array"
},
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
},
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"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"
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
},
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "id": "RepairApplicationRequest",
- "properties": {},
- "type": "object"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "id": "CertificateRawData",
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
"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: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>",
+ "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"
},
- "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",
+ "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"
- },
- "BuildInfo": {
- "description": "Google Cloud Container Builder build information.",
- "id": "BuildInfo",
- "properties": {
- "cloudBuildId": {
- "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
}
},
"type": "object"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "id": "ScriptHandler",
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
"properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
}
},
"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",
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "id": "ListAuthorizedDomainsResponse",
"properties": {
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
},
- "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"
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataExperimental",
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "id": "DomainMapping",
"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"
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "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"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
"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",
+ "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"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
"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.",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
"type": "object"
},
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "id": "TrafficSplit",
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "id": "ZipInfo",
"properties": {
- "shardBy": {
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "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"
+ "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"
},
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
+ "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"
},
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta",
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
"properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
},
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "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"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "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"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "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"
},
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "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"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "standardSchedulerSettings": {
+ "$ref": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment."
+ },
+ "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"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "id": "ListServicesResponse",
+ "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": {
- "services": {
- "description": "The services belonging to the requested application.",
+ "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": {
- "$ref": "Service"
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "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"
- }
- },
- "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."
},
- "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."
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
},
- "build": {
- "$ref": "BuildInfo",
- "description": "Google Cloud Container Builder build information."
+ "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"
},
- "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"
- }
- },
- "type": "object"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "id": "Resources",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
"items": {
- "$ref": "Volume"
+ "type": "string"
},
"type": "array"
},
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
},
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
},
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
}
},
"type": "object"
},
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "id": "Volume",
+ "ResourceRecord": {
+ "description": "A DNS resource record.",
+ "id": "ResourceRecord",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
"type": "string"
},
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
- "type": "number"
+ "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"
},
- "name": {
- "description": "Unique name for the volume.",
+ "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"
}
},
"type": "object"
},
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "id": "ListInstancesResponse",
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
"type": "string"
},
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
}
},
"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