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

Unified Diff: discovery/googleapis_beta/appengine__v1beta5.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: discovery/googleapis_beta/appengine__v1beta5.json
diff --git a/discovery/googleapis_beta/appengine__v1beta5.json b/discovery/googleapis_beta/appengine__v1beta5.json
index 1dfa38323d8900d1176975b109bcc2684a5f6cbe..513092cb971c6771a0bd97905a7ebb9a448ee794 100644
--- a/discovery/googleapis_beta/appengine__v1beta5.json
+++ b/discovery/googleapis_beta/appengine__v1beta5.json
@@ -2,14 +2,14 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/appengine.admin": {
"description": "View and manage your applications deployed on Google App Engine"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -30,22 +30,6 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
"access_token": {
"description": "OAuth access token.",
"location": "query",
@@ -67,13 +51,13 @@
"location": "query",
"type": "boolean"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
@@ -88,18 +72,13 @@
"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"
},
- "callback": {
- "description": "JSONP",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
@@ -115,6 +94,27 @@
],
"location": "query",
"type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
}
},
"protocol": "rest",
@@ -200,8 +200,115 @@
}
},
"resources": {
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.get",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$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"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
"services": {
"methods": {
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/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",
@@ -254,12 +361,6 @@
"appsId"
],
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
"location": "query",
@@ -270,6 +371,12 @@
"location": "path",
"required": true,
"type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
}
},
"path": "v1beta5/apps/{appsId}/services",
@@ -291,14 +398,14 @@
"servicesId"
],
"parameters": {
- "servicesId": {
- "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"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
"required": true,
"type": "string"
@@ -313,41 +420,44 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
- },
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "httpMethod": "DELETE",
- "id": "appengine.apps.services.delete",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
},
"resources": {
"versions": {
"methods": {
+ "create": {
+ "description": "Deploys new code and resource files to a new version.",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/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.",
"httpMethod": "DELETE",
@@ -530,44 +640,58 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
- },
- "create": {
- "description": "Deploys new code and resource files to a new version.",
- "httpMethod": "POST",
- "id": "appengine.apps.services.versions.create",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
},
"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": {
+ "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"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/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",
@@ -707,53 +831,6 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
- },
- "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": {
- "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": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
}
}
@@ -837,1263 +914,1108 @@
]
}
}
- },
- "locations": {
- "methods": {
- "get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "id": "appengine.apps.locations.get",
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "response": {
- "$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"
- ]
- },
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "id": "appengine.apps.locations.list",
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "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 `name`. The resource that owns the locations collection, if applicable.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- }
- },
- "path": "v1beta5/apps/{appsId}/locations",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
}
}
}
},
- "revision": "20170721",
+ "revision": "20170811",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Alpha",
+ "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": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
"type": "string"
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
},
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
},
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
"type": "string"
}
},
"type": "object"
},
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "id": "Application",
+ "SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "id": "SourceReference",
"properties": {
- "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.",
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
"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.",
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
"type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
+ }
+ },
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
+ "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).",
"type": "string"
- },
- "codeBucket": {
- "description": "A 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": "object"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
"type": "string"
},
- "location": {
- "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",
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
},
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"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.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
},
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "id": "Network",
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
"properties": {
- "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"
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
},
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
"items": {
- "type": "string"
+ "$ref": "Location"
},
"type": "array"
- },
- "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"
},
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "id": "Instance",
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "id": "Version",
"properties": {
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "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."
},
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
+ "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."
},
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
"type": "boolean"
},
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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"
},
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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 from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
"type": "string"
},
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "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."
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "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"
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
+ "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."
],
- "type": "string"
+ "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"
+ },
+ "type": "array"
},
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
+ "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"
},
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "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/v1/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"
},
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "Library"
+ },
+ "type": "array"
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
"type": "string"
},
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
+ "creationTime": {
+ "description": "Time that this version was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- }
- },
- "type": "object"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "id": "UrlDispatchRule",
- "properties": {
- "service": {
- "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
"type": "string"
},
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "id": {
+ "description": "Relative name of the version within the module. 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"
},
- "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"
- }
- },
- "type": "object"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "id": "ListVersionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
"type": "string"
},
- "versions": {
- "description": "The versions belonging to the requested service.",
+ "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": "Version"
+ "$ref": "UrlMap"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "id": "ApiEndpointHandler",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "id": "AutomaticScaling",
- "properties": {
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
},
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
+ "deployer": {
+ "description": "Email address of the user who created this version.@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"
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
- "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",
+ "diskUsageBytes": {
+ "description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
+ "format": "int64",
"type": "string"
},
- "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"
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
},
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
+ "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."
},
- "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",
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
"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."
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "format": "int32",
- "type": "integer"
}
},
"type": "object"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "id": "NetworkUtilization",
+ "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": {
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
+ "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": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
"format": "int32",
"type": "integer"
},
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
+ "targetRequestCountPerSec": {
+ "description": "Target requests per second.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "id": "Location",
+ "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": {
- "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\"",
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
"type": "string"
},
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
+ "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"
- },
- "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"
},
- "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",
+ "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": {
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
},
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "urlRegex": {
+ "description": "A 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"
},
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
+ "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 action given in auth_fail_action is taken."
+ ],
"type": "string"
},
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
},
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "id": "SourceReference",
- "properties": {
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
- "type": "string"
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "id": "DebugInstanceRequest",
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\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).",
+ "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"
- }
- },
- "type": "object"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "id": "Library",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
+ },
+ "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"
},
- "version": {
- "description": "Version of the library to select, or \"latest\".",
+ "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 an401 HTTP status code and an error message."
+ ],
"type": "string"
}
},
"type": "object"
},
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta5",
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
"properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "script": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "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 action given in auth_fail_action is taken."
+ ],
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "url": {
+ "description": "URL to serve the endpoint at.",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "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"
},
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "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 an401 HTTP status code and an error message."
+ ],
"type": "string"
}
},
"type": "object"
},
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "id": "ListLocationsResponse",
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "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"
},
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
+ "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"
}
},
"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",
+ "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": {
- "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"
- },
- "deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
"type": "string"
},
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
- "format": "int64",
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
"type": "string"
},
- "healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
+ "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"
+ },
+ "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": {
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
},
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
+ "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"
},
- "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."
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
},
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"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"
+ "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"
},
- "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.",
+ "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"
},
- "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 from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "type": "string"
- },
- "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",
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "id": "DiskUtilization",
+ "properties": {
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
+ "format": "int32",
+ "type": "integer"
},
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
- "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": {
- "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"
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
},
- "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"
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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",
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
},
- "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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "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"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "Library"
- },
- "type": "array"
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataExperimental",
+ "properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
"type": "string"
},
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
"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.",
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "id": {
- "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
"type": "string"
},
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
- },
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "id": "ContainerInfo",
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
"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\"",
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
"type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "id": "RequestUtilization",
+ "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": {
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
+ "details": {
+ "description": "A list of messages that carry the error details. There is 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"
},
- "targetRequestCountPerSec": {
- "description": "Target requests per second.",
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"type": "object"
},
- "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",
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
"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."
- ],
- "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 an401 HTTP status code and an error message."
- ],
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
},
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "A 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"
+ "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"
},
- "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 action given in auth_fail_action is taken."
- ],
+ "oauth2ClientSecret": {
+ "description": "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"
},
- "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."
- ],
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
"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",
+ "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": {
- "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"
+ "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"
},
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "id": "ApiConfigHandler",
+ "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": {
- "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 an401 HTTP status code and an error message."
- ],
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
+ "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"
},
- "login": {
- "description": "Level of login required to access this resource. Defaults to optional.",
+ "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": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP"
],
"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 action given in auth_fail_action is taken."
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address."
],
"type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
}
},
"type": "object"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "id": "Operation",
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
"properties": {
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
},
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
},
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
+ "type": "array"
},
- "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"
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@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"
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @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.",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
"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",
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
"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"
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
}
},
"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",
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "id": "Deployment",
"properties": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
},
- "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"
+ "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."
},
- "httpHeaders": {
+ "files": {
"additionalProperties": {
- "type": "string"
+ "$ref": "FileInfo"
},
- "description": "HTTP headers to use for all responses from these URLs.",
+ "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": "Volumes mounted within the app container.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
},
- "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.",
- "type": "string"
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
},
- "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"
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
},
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "id": "ScriptHandler",
+ "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 other tasks such as API requests from mobile devices or backend data analysis. 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": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ },
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
}
},
"type": "object"
},
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "id": "DiskUtilization",
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "id": "Volume",
"properties": {
- "targetReadBytesPerSec": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
},
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
},
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "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",
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"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",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "OperationMetadataExperimental": {
+ "OperationMetadata": {
"description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataExperimental",
+ "id": "OperationMetadata",
"properties": {
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
"insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
+ "description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
},
"target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "id": "CpuUtilization",
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
"properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
},
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"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",
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is 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"
+ "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"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
},
"type": "array"
},
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "id": "IdentityAwareProxy",
- "properties": {
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "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"
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
},
- "oauth2ClientSecret": {
- "description": "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",
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"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",
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
"properties": {
- "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"
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
},
- "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.",
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
"enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
],
"enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ "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"
- }
- },
- "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"
},
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
}
},
"type": "object"
},
- "OperationMetadataV1Beta": {
+ "OperationMetadataV1Alpha": {
"description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1Beta",
+ "id": "OperationMetadataV1Alpha",
"properties": {
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
@@ -2120,7 +2042,7 @@
"type": "string"
},
"method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
"type": "string"
},
"endTime": {
@@ -2131,255 +2053,333 @@
},
"type": "object"
},
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "id": "ListServicesResponse",
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "id": "Network",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "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"
},
- "services": {
- "description": "The services belonging to the requested application.",
+ "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": {
- "$ref": "Service"
+ "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"
},
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "id": "Deployment",
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application",
"properties": {
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
"items": {
- "$ref": "SourceReference"
+ "$ref": "UrlDispatchRule"
},
"type": "array"
},
- "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."
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
},
- "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": "Volumes mounted within the app container.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
},
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
},
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
+ "iap": {
+ "$ref": "IdentityAwareProxy"
},
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "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"
+ },
+ "codeBucket": {
+ "description": "A 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"
+ },
+ "location": {
+ "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"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
}
},
"type": "object"
},
- "Service": {
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "id": "Service",
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
"properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "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"
},
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ "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"
},
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "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"
},
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "id": "Volume",
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "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"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
+ "vmId": {
+ "description": "Virtual machine ID of this instance. 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"
},
"name": {
- "description": "Unique name for the volume.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "id": "ListOperationsResponse",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
"type": "string"
},
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadata",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
"type": "string"
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
}
},
"type": "object"
},
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "id": "ListInstancesResponse",
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
- "instances": {
- "description": "The instances belonging to the requested version.",
+ "versions": {
+ "description": "The versions belonging to the requested service.",
"items": {
- "$ref": "Instance"
+ "$ref": "Version"
},
"type": "array"
}
},
"type": "object"
},
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "id": "OperationMetadataV1",
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
"properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
+ "properties": {
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
},
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "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"
},
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "maxIdleInstances": {
+ "description": "Maximum number of idle 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"
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "format": "int32",
+ "type": "integer"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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",
+ "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."
}
},
"type": "object"
},
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "id": "ErrorHandler",
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "id": "NetworkUtilization",
"properties": {
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "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."
- ],
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
},
- "staticFile": {
- "description": "Static file content to be served for this error.",
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
"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"
+ },
+ "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"
« no previous file with comments | « discovery/googleapis_beta/appengine__v1beta4.json ('k') | discovery/googleapis_beta/clouderrorreporting__v1beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698