package google.appengine.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Applications
appengine.proto:170Manages App Engine applications.
rpc GetApplication (, )
appengine.proto:172Gets information about an application.
message
appengine.proto:192Request message for `Applications.GetApplication`.
string name = 1
Name of the Application resource to get. Example: `apps/myapp`.
message
application.proto:29An Application resource contains the top-level configuration of an App Engine application.
string name = 1
Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
string id = 2
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`.
repeated dispatch_rules = 3
HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
string auth_domain = 6
Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
string location_id = 7
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 US `europe-west` - Western Europe `us-east1` - Eastern US
string code_bucket = 8
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
optional default_cookie_expiration = 9
Cookie expiration policy for this application. @OutputOnly
string default_hostname = 11
Hostname used to reach this application, as resolved by App Engine. @OutputOnly
string default_bucket = 12
Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
rpc RepairApplication (, )
appengine.proto:182Recreates the required App Engine features for the application in your project, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example "*Error retrieving the App Engine service account*".
message
appengine.proto:198Request message for 'Applications.RepairApplication'.
string name = 1
Name of the application to repair. Example: `apps/myapp`
service Instances
appengine.proto:36Manages instances of a version.
rpc ListInstances (, )
appengine.proto:38Lists the instances of a version.
message
appengine.proto:333Request message for `Instances.ListInstances`.
string parent = 1
Name of the parent Version resource. Example: `apps/myapp/services/default/versions/v1`.
int32 page_size = 2
Maximum results to return per page.
string page_token = 3
Continuation token for fetching the next page of results.
message
appengine.proto:346Response message for `Instances.ListInstances`.
repeated instances = 1
The instances belonging to the requested version.
string next_page_token = 2
Continuation token for fetching the next page of results.
rpc GetInstance (, )
appengine.proto:45Gets instance information.
message
appengine.proto:355Request message for `Instances.GetInstance`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`.
rpc DeleteInstance (, )
appengine.proto:52Stops a running instance.
message
appengine.proto:362Request message for `Instances.DeleteInstance`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`.
rpc DebugInstance (, )
appengine.proto:67Enables 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.
message
appengine.proto:369Request message for `Instances.DebugInstance`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`.
service Services
appengine.proto:136Manages services of an application.
rpc ListServices (, )
appengine.proto:138Lists all the services in the application.
message
appengine.proto:204Request message for `Services.ListServices`.
string parent = 1
Name of the parent Application resource. Example: `apps/myapp`.
int32 page_size = 2
Maximum results to return per page.
string page_token = 3
Continuation token for fetching the next page of results.
message
appengine.proto:216Response message for `Services.ListServices`.
repeated services = 1
The services belonging to the requested application.
string next_page_token = 2
Continuation token for fetching the next page of results.
rpc GetService (, )
appengine.proto:145Gets the current configuration of the specified service.
message
appengine.proto:225Request message for `Services.GetService`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default`.
rpc UpdateService (, )
appengine.proto:152Updates the configuration of the specified service.
rpc DeleteService (, )
appengine.proto:161Deletes the specified service and all enclosed versions.
message
appengine.proto:261Request message for `Services.DeleteService`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default`.
service Versions
appengine.proto:77Manages versions of a service.
rpc ListVersions (, )
appengine.proto:79Lists the versions of a service.
message
appengine.proto:267Request message for `Versions.ListVersions`.
string parent = 1
Name of the parent Service resource. Example: `apps/myapp/services/default`.
VersionView view = 2
Controls the set of fields returned in the `List` response.
int32 page_size = 3
Maximum results to return per page.
string page_token = 4
Continuation token for fetching the next page of results.
message
appengine.proto:283Response message for `Versions.ListVersions`.
repeated versions = 1
The versions belonging to the requested service.
string next_page_token = 2
Continuation token for fetching the next page of results.
rpc GetVersion (, )
appengine.proto:88Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.
message
appengine.proto:292Request message for `Versions.GetVersion`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`.
VersionView view = 2
Controls the set of fields returned in the `Get` response.
rpc CreateVersion (, )
appengine.proto:95Deploys code and resource files to a new version.
rpc UpdateVersion (, )
appengine.proto:118Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
message
appengine.proto:312Request message for `Versions.UpdateVersion`.
string name = 1
Name of the resource to update. Example: `apps/myapp/services/default/versions/1`.
optional version = 2
A Version containing the updated resource. Only fields set in the field mask will be updated.
optional update_mask = 3
Standard field mask for the set of fields to be updated.
rpc DeleteVersion (, )
appengine.proto:127Deletes an existing Version resource.
message
appengine.proto:326Request message for `Versions.DeleteVersion`.
string name = 1
Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`.
message
app_yaml.proto:30[Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
Used in:
AuthFailAction auth_fail_action = 1
Action to take when users access resources that require authentication. Defaults to `redirect`.
LoginRequirement login = 2
Level of login required to access this resource. Defaults to `optional`.
string script = 3
Path to the script from the application root directory.
SecurityLevel security_level = 4
Security (HTTPS) enforcement for this URL.
string url = 5
URL to serve the endpoint at.
message
app_yaml.proto:184Uses Google Cloud Endpoints to handle requests.
Used in:
string script_path = 1
Path to the script from the application root directory.
message
audit_data.proto:28App Engine admin service audit log.
oneof method
Detailed information about methods that require it. Does not include simple Get, List or Delete methods because all significant information (resource name, number of returned elements for List operations) is already included in parent audit log message.
update_service = 1
Detailed information about UpdateService call.
create_version = 2
Detailed information about CreateVersion call.
Actions to take when the user is not logged in.
Used in: ,
AUTH_FAIL_ACTION_UNSPECIFIED = 0
Not specified. `AUTH_FAIL_ACTION_REDIRECT` is assumed.
AUTH_FAIL_ACTION_REDIRECT = 1
Redirects user to "accounts.google.com". The user is redirected back to the application URL after signing in or creating an account.
AUTH_FAIL_ACTION_UNAUTHORIZED = 2
Rejects request with a `401` HTTP status code and an error message.
message
version.proto:186Automatic scaling is based on request rate, response latencies, and other application metrics.
Used in:
optional cool_down_period = 1
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.
optional cpu_utilization = 2
Target scaling by CPU usage.
int32 max_concurrent_requests = 3
Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
int32 max_idle_instances = 4
Maximum number of idle instances that should be maintained for this version.
int32 max_total_instances = 5
Maximum number of instances that should be started to handle requests.
optional max_pending_latency = 6
Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
int32 min_idle_instances = 7
Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
int32 min_total_instances = 8
Minimum number of instances that should be maintained for this version.
optional min_pending_latency = 9
Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
optional request_utilization = 10
Target scaling by request utilization.
optional disk_utilization = 11
Target scaling by disk usage.
optional network_utilization = 12
Target scaling by network usage.
message
version.proto:238A 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.
Used in:
optional idle_timeout = 1
Duration of time after the last request that an instance must wait before the instance is shut down.
int32 max_instances = 2
Maximum number of instances to create for this version.
message
deploy.proto:60Docker image that is used to start a VM container for the version you deploy.
Used in:
string image = 1
URI to the hosted container image in a Docker repository. 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"
message
version.proto:259Target scaling by CPU usage.
Used in:
optional aggregation_window_length = 1
Period of time over which CPU utilization is calculated.
double target_utilization = 2
Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
message
audit_data.proto:49Detailed information about CreateVersion call.
Used in:
optional request = 1
Create version request.
message
appengine.proto:302Request message for `Versions.CreateVersion`.
Used as request type in: Versions.CreateVersion
Used as field type in:
string parent = 1
Name of the parent resource to create this version under. Example: `apps/myapp/services/default`.
optional version = 2
Application deployment configuration.
message
deploy.proto:27Code and application artifacts used to deploy a version to App Engine.
Used in:
map<string, > files = 1
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.
optional container = 2
A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
optional zip = 3
The zip file for this deployment, if this is a zip deployment.
message
version.proto:278Target scaling by disk usage. Only applicable for VM runtimes.
Used in:
int32 target_write_bytes_per_second = 14
Target bytes written per second.
int32 target_write_ops_per_second = 15
Target ops written per second.
int32 target_read_bytes_per_second = 16
Target bytes read per second.
int32 target_read_ops_per_second = 17
Target ops read per seconds.
message
app_yaml.proto:50Custom static error page to be served when an error occurs.
Used in:
ErrorHandler.ErrorCode error_code = 1
Error condition this handler applies to.
string static_file = 2
Static file content to be served for this error.
string mime_type = 3
MIME type of file. Defaults to `text/html`.
Error codes.
Used in:
ERROR_CODE_UNSPECIFIED = 0
Not specified. ERROR_CODE_DEFAULT is assumed.
ERROR_CODE_DEFAULT = 0
All other error types.
ERROR_CODE_OVER_QUOTA = 1
Application has exceeded a resource quota.
ERROR_CODE_DOS_API_DENIAL = 2
Client blocked by the application's Denial of Service protection configuration.
ERROR_CODE_TIMEOUT = 3
Deadline reached before the application responds.
message
deploy.proto:43Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Used in:
string source_url = 1
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\>'.
string sha1_sum = 2
The SHA1 hash of the file, in hex.
string mime_type = 3
The MIME type of the file. Defaults to the value from Google Cloud Storage.
message
app_yaml.proto:192Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
Used in:
bool disable_health_check = 1
Whether to explicitly disable health checks for this instance.
string host = 2
Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
uint32 healthy_threshold = 3
Number of consecutive successful health checks required before receiving traffic.
uint32 unhealthy_threshold = 4
Number of consecutive failed health checks required before removing traffic.
uint32 restart_threshold = 5
Number of consecutive failed health checks required before an instance is restarted.
optional check_interval = 6
Interval between health checks.
optional timeout = 7
Time before the health check is considered failed.
Available inbound services.
Used in:
INBOUND_SERVICE_UNSPECIFIED = 0
Not specified.
INBOUND_SERVICE_MAIL = 1
Allows an application to receive mail.
INBOUND_SERVICE_MAIL_BOUNCE = 2
Allows an application to receive email-bound notifications.
INBOUND_SERVICE_XMPP_ERROR = 3
Allows an application to receive error stanzas.
INBOUND_SERVICE_XMPP_MESSAGE = 4
Allows an application to receive instant messages.
INBOUND_SERVICE_XMPP_SUBSCRIBE = 5
Allows an application to receive user subscription POSTs.
INBOUND_SERVICE_XMPP_PRESENCE = 6
Allows an application to receive a user's chat presence.
INBOUND_SERVICE_CHANNEL_PRESENCE = 7
Registers an application for notifications when a client connects or disconnects from a channel.
INBOUND_SERVICE_WARMUP = 9
Enables warmup requests.
message
instance.proto:29An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Used as response type in: Instances.GetInstance
Used as field type in:
string name = 1
Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
string id = 2
Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
string app_engine_release = 3
App Engine release this instance is running on. @OutputOnly
Instance.Availability availability = 4
Availability of the instance. @OutputOnly
string vm_name = 5
Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
string vm_zone_name = 6
Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
string vm_id = 7
Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
optional start_time = 8
Time that this instance was started. @OutputOnly
int32 requests = 9
Number of requests since this instance was started. @OutputOnly
int32 errors = 10
Number of errors since this instance was started. @OutputOnly
float qps = 11
Average queries per second (QPS) over the last minute. @OutputOnly
int32 average_latency = 12
Average latency (ms) over the last minute. @OutputOnly
int64 memory_usage = 13
Total memory in use (bytes). @OutputOnly
string vm_status = 14
Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
bool vm_debug_enabled = 15
Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
Availability of the instance.
Used in:
UNSPECIFIED = 0
RESIDENT = 1
DYNAMIC = 2
message
app_yaml.proto:220Third-party Python runtime library that is required by the application.
Used in:
string name = 1
Name of the library. Example: "django".
string version = 2
Version of the library to select, or "latest".
message
location.proto:29Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].
bool standard_environment_available = 2
App Engine Standard Environment is available in the given location. @OutputOnly
bool flexible_environment_available = 4
App Engine Flexible Environment is available in the given location. @OutputOnly
Methods to restrict access to a URL based on login status.
Used in: ,
LOGIN_UNSPECIFIED = 0
Not specified. `LOGIN_OPTIONAL` is assumed.
LOGIN_OPTIONAL = 1
Does not require that the user is signed in.
LOGIN_ADMIN = 2
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.
LOGIN_REQUIRED = 3
If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken.
message
version.proto:249A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Used in:
int32 instances = 1
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.
message
version.proto:308Extra network settings. Only applicable for VM runtimes.
Used in:
repeated string forwarded_ports = 1
List of ports, or port pairs, to forward from the virtual machine to the application container.
string instance_tag = 2
Tag to apply to the VM instance during creation.
string name = 3
Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
message
version.proto:293Target scaling by network usage. Only applicable for VM runtimes.
Used in:
int32 target_sent_bytes_per_second = 1
Target bytes sent per second.
int32 target_sent_packets_per_second = 11
Target packets sent per second.
int32 target_received_bytes_per_second = 12
Target bytes received per second.
int32 target_received_packets_per_second = 13
Target packets received per second.
message
operation.proto:29Metadata for the given [google.longrunning.Operation][google.longrunning.Operation].
string method = 1
API method that initiated this operation. Example: `google.appengine.v1.Versions.CreateVersion`. @OutputOnly
optional insert_time = 2
Time that this operation was created. @OutputOnly
optional end_time = 3
Time that this operation completed. @OutputOnly
string user = 4
User who requested this operation. @OutputOnly
string target = 5
Name of the resource that this operation is acting on. Example: `apps/myapp/services/default`. @OutputOnly
message
version.proto:269Target scaling by request utilization. Only applicable for VM runtimes.
Used in:
int32 target_request_count_per_second = 1
Target requests per second.
int32 target_concurrent_requests = 2
Target number of concurrent requests.
message
version.proto:324Machine resources for a version.
Used in:
double cpu = 1
Number of CPU cores needed.
double disk_gb = 2
Disk size (GB) needed.
double memory_gb = 3
Memory (GB) needed.
message
app_yaml.proto:178Executes a script to handle the request that matches the URL pattern.
Used in:
string script_path = 1
Path to the script from the application root directory.
Methods to enforce security (HTTPS) on a URL.
Used in: ,
SECURE_UNSPECIFIED = 0
Not specified.
SECURE_DEFAULT = 0
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.
SECURE_NEVER = 1
Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.
SECURE_OPTIONAL = 2
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.
SECURE_ALWAYS = 3
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.
message
service.proto:33A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Used as response type in: Services.GetService
Used as field type in: ,
string name = 1
Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
string id = 2
Relative name of the service within the application. Example: `default`. @OutputOnly
optional split = 3
Mapping that defines fractional HTTP traffic diversion to different versions within the service.
Run states of a version.
Used in:
SERVING_STATUS_UNSPECIFIED = 0
Not specified.
SERVING = 1
Currently serving. Instances are created according to the scaling settings of the version.
STOPPED = 2
Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to `SERVING`.
message
app_yaml.proto:142Files 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.
Used in:
string path = 1
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.
string upload_path_regex = 2
Regular expression that matches the file paths for all files that should be referenced by this handler.
map<string, string> http_headers = 3
HTTP headers to use for all responses from these URLs.
string mime_type = 4
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.
optional expiration = 5
Time a static file served by this handler should be cached by web proxies and browsers.
bool require_matching_file = 6
Whether this handler should match the request if the file referenced by the handler does not exist.
bool application_readable = 7
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.
message
service.proto:53Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
Used in:
TrafficSplit.ShardBy shard_by = 1
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.
map<string, double> allocations = 2
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.
Available sharding mechanisms.
Used in:
UNSPECIFIED = 0
Diversion method unspecified.
COOKIE = 1
Diversion based on a specially named cookie, "GOOGAPPUID." The cookie must be set by the application itself or no diversion will occur.
IP = 2
Diversion based on applying the modulus operation to a fingerprint of the IP address.
message
audit_data.proto:43Detailed information about UpdateService call.
Used in:
optional request = 1
Update service request.
message
appengine.proto:231Request message for `Services.UpdateService`.
Used as request type in: Services.UpdateService
Used as field type in:
string name = 1
Name of the resource to update. Example: `apps/myapp/services/default`.
optional service = 2
A Service resource containing the updated service. Only fields set in the field mask will be updated.
optional update_mask = 3
Standard field mask for the set of fields to be updated.
bool migrate_traffic = 4
Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
message
application.proto:94Rules to match an HTTP request and dispatch that request to a service.
Used in:
string domain = 1
Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
string path = 2
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.
string service = 3
Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
message
app_yaml.proto:85URL 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.
Used in:
string url_regex = 1
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.
oneof handler_type
Type of handler for this URL pattern.
static_files = 2
Returns the contents of a file, such as an image, as the response.
script = 3
Executes a script to handle the request that matches this URL pattern.
api_endpoint = 4
Uses API Endpoints to handle requests.
SecurityLevel security_level = 5
Security (HTTPS) enforcement for this URL.
LoginRequirement login = 6
Level of login required to access this resource.
AuthFailAction auth_fail_action = 7
Action to take when users access resources that require authentication. Defaults to `redirect`.
UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8
`30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
Redirect codes.
Used in:
REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED = 0
Not specified. `302` is assumed.
REDIRECT_HTTP_RESPONSE_CODE_301 = 1
`301 Moved Permanently` code.
REDIRECT_HTTP_RESPONSE_CODE_302 = 2
`302 Moved Temporarily` code.
REDIRECT_HTTP_RESPONSE_CODE_303 = 3
`303 See Other` code.
REDIRECT_HTTP_RESPONSE_CODE_307 = 4
`307 Temporary Redirect` code.
message
version.proto:32A Version resource is a specific set of source code and configuration files that are deployed into a service.
Used as response type in: Versions.GetVersion
Used as field type in: , ,
string name = 1
Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
string id = 2
Relative name of the version within the service. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
oneof scaling
Controls how instances are created. Defaults to `AutomaticScaling`.
automatic_scaling = 3
Automatic scaling is based on request rate, response latencies, and other application metrics.
basic_scaling = 4
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.
manual_scaling = 5
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
repeated InboundServiceType inbound_services = 6
Before an application can receive email or XMPP messages, the application must be configured to enable the service.
string instance_class = 7
Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
optional network = 8
Extra network settings. Only applicable for VM runtimes.
optional resources = 9
Machine resources for this version. Only applicable for VM runtimes.
string runtime = 10
Desired runtime. Example: `python27`.
bool threadsafe = 11
Whether multiple requests can be dispatched to this version at once.
bool vm = 12
Whether to deploy this version in a container on a virtual machine.
map<string, string> beta_settings = 13
Metadata settings that are supplied to this version to enable beta runtime features.
string env = 14
App Engine execution environment for this version. Defaults to `standard`.
ServingStatus serving_status = 15
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`.
string created_by = 16
Email address of the user who created this version. @OutputOnly
optional create_time = 17
Time that this version was created. @OutputOnly
int64 disk_usage_bytes = 18
Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk. @OutputOnly
repeated handlers = 100
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.
repeated error_handlers = 101
Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
repeated libraries = 102
Configuration for third-party Python runtime libraries that are required by the application. Only returned in `GET` requests if `view=FULL` is set.
optional api_config = 103
Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
map<string, string> env_variables = 104
Environment variables available to the application. Only returned in `GET` requests if `view=FULL` is set.
optional default_expiration = 105
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.
optional health_check = 106
Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
string nobuild_files_regex = 107
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.
optional deployment = 108
Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
string version_url = 109
Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" @OutputOnly
Fields that should be returned when [Version][google.appengine.v1.Version] resources are retreived.
Used in: ,
BASIC = 0
Basic version information including scaling and inbound services, but not detailed deployment information.
FULL = 1
The information from `BASIC`, plus detailed information about the deployment. This format is required when creating resources, but is not returned in `Get` or `List` by default.
message
deploy.proto:67Used in:
string source_url = 3
URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\<bucket\>/\<object\>'.
int32 files_count = 4
An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.