blob: b2b7332926dfd778944699817791caa637c623d3 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a> . <a href="appengine_v1.apps.services.versions.html">versions</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="appengine_v1.apps.services.versions.instances.html">instances()</a></code>
79</p>
80<p class="firstline">Returns the instances Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070083 <code><a href="#create">create(appsId, servicesId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070084<p class="firstline">Deploys code and resource files to a new version.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes an existing Version resource.</p>
88<p class="toc_element">
89 <code><a href="#get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080090<p class="firstline">Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070091<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 <code><a href="#list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070093<p class="firstline">Lists the versions of a service.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070098 <code><a href="#patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700100<h3>Method Details</h3>
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code class="details" id="create">create(appsId, servicesId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700103 <pre>Deploys code and resource files to a new version.
104
105Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800106 appsId: string, Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700107 servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700109 The object takes the form of:
110
111{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112 "endpointsApiService": { # 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. Only valid for App Engine Flexible environment deployments.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). # 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.
113 "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
114 "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
115 "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800116 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
117 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 "defaultExpiration": "A String", # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700119 "basicScaling": { # 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. # 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.
120 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
121 "maxInstances": 42, # Maximum number of instances to create for this version.
122 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700123 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
125 "A String",
126 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400127 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
128 # AutomaticScaling: F1, F2, F4, F4_1G
129 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800130 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700131 { # Custom static error page to be served when an error occurs.
132 "errorCode": "A String", # Error condition this handler applies to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800133 "mimeType": "A String", # MIME type of file. Defaults to text/html.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700134 "staticFile": "A String", # Static file content to be served for this error.
135 },
136 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700137 "id": "A String", # 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-".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700139 "checkInterval": "A String", # Interval between health checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700140 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700142 "timeout": "A String", # Time before the check is considered failed.
143 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700144 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
145 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700146 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147 "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800148 "apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700149 "url": "A String", # URL to serve the endpoint at.
150 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 "login": "A String", # Level of login required to access this resource. Defaults to optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700152 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700153 "script": "A String", # Path to the script from the application root directory.
154 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700155 "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
156 "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
157 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
158 "A String",
159 ],
160 "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
161 "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
162 "subnetworkName": "A String", # 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.
163 # If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
164 # If the network that the 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.
165 # If the network that the 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 App Engine flexible environment application.
166 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700167 "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700168 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
169 "checkInterval": "A String", # Interval between health checks.
170 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
171 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
172 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
173 "timeout": "A String", # Time before the health check is considered failed.
174 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
175 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700176 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800177 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700178 { # Third-party Python runtime library that is required by the application.
179 "version": "A String", # Version of the library to select, or "latest".
180 "name": "A String", # Name of the library. Example: "django".
181 },
182 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700183 "entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
184 "shell": "A String", # The format should be a shell command that can be fed to bash -c.
185 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800186 "env": "A String", # App Engine execution environment for this version.Defaults to standard.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700188 "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
189 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700190 "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700191 "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
192 "targetSentPacketsPerSecond": 42, # Target packets sent per second.
193 "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
194 "targetSentBytesPerSecond": 42, # Target bytes sent per second.
195 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
197 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
198 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700199 "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700200 "targetReadOpsPerSecond": 42, # Target ops read per seconds.
201 "targetWriteBytesPerSecond": 42, # Target bytes written per second.
202 "targetReadBytesPerSecond": 42, # Target bytes read per second.
203 "targetWriteOpsPerSecond": 42, # Target ops written per second.
204 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205 "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700206 "targetConcurrentRequests": 42, # Target number of concurrent requests.
207 "targetRequestCountPerSecond": 42, # Target requests per second.
208 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700209 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
210 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
211 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
212 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213 "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
214 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800215 "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700216 "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
217 "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
218 "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
219 "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
220 "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
221 "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700222 },
223 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800224 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700225 "a_key": "A String",
226 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400228 "memoryGb": 3.14, # Memory (GB) needed.
229 "diskGb": 3.14, # Disk size (GB) needed.
230 "cpu": 3.14, # Number of CPU cores needed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800231 "volumes": [ # User specified volumes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800233 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
234 "name": "A String", # Unique name for the volume.
235 "sizeGb": 3.14, # Volume size in gigabytes.
236 },
237 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700238 },
239 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800240 "instances": 42, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700241 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
243 "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
244 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700245 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
246 "A String",
247 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400249 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
250 "a_key": "A String",
251 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800252 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
253 "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700254 "files": { # 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.
255 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800256 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700257 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700258 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
259 },
260 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700261 "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
262 "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
263 "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
264 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700265 "container": { # 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. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
266 "image": "A String", # 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"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700267 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700268 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700269 "filesCount": 42, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700270 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700271 },
272 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700273 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700274 "checkInterval": "A String", # Interval between health checks.
275 "initialDelay": "A String", # The initial delay before starting to execute the checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700276 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
277 "timeout": "A String", # Time before the check is considered failed.
278 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700279 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
280 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700281 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400282 "createTime": "A String", # Time that this version was created.@OutputOnly
Dan O'Mearadd494642020-05-01 07:42:23 -0700283 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
284 "runtimeApiVersion": "A String", # 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/&lt;language&gt;/config/appref
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400285 "nobuildFilesRegex": "A String", # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800286 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
287 "handlers": [ # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700288 { # 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.
289 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800290 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700291 "urlRegex": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700293 "scriptPath": "A String", # Path to the script from the application root directory.
294 },
295 "staticFiles": { # 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. # Returns the contents of a file, such as an image, as the response.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800296 "mimeType": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 "applicationReadable": True or False, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700298 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
299 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
300 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
301 "path": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700302 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
303 "a_key": "A String",
304 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700305 },
306 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
307 "scriptPath": "A String", # Path to the script from the application root directory.
308 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700309 "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700310 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700311 },
312 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800313 "servingStatus": "A String", # 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.
314 "runtime": "A String", # Desired runtime. Example: python27.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700315 }
316
317 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400318 Allowed values
319 1 - v1 error format
320 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700321
322Returns:
323 An object of the form:
324
325 { # This resource represents a long-running operation that is the result of a network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700326 "response": { # 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.
327 "a_key": "", # Properties of the object. Contains field @type with type URL.
328 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400329 "metadata": { # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700330 "a_key": "", # Properties of the object. Contains field @type with type URL.
331 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700332 "done": True or False, # 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.
333 "name": "A String", # 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 be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700334 "error": { # 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700335 "message": "A String", # 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.
336 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700337 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700338 {
339 "a_key": "", # Properties of the object. Contains field @type with type URL.
340 },
341 ],
342 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</code>
348 <pre>Deletes an existing Version resource.
349
350Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800351 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700352 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
353 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
354 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700358
359Returns:
360 An object of the form:
361
362 { # This resource represents a long-running operation that is the result of a network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700363 "response": { # 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.
364 "a_key": "", # Properties of the object. Contains field @type with type URL.
365 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400366 "metadata": { # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700367 "a_key": "", # Properties of the object. Contains field @type with type URL.
368 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700369 "done": True or False, # 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.
370 "name": "A String", # 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 be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371 "error": { # 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700372 "message": "A String", # 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.
373 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700374 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700375 {
376 "a_key": "", # Properties of the object. Contains field @type with type URL.
377 },
378 ],
379 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800385 <pre>Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700386
387Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800388 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700389 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
390 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
391 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400392 Allowed values
393 1 - v1 error format
394 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800395 view: string, Controls the set of fields returned in the Get response.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700396
397Returns:
398 An object of the form:
399
400 { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700401 "endpointsApiService": { # 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. Only valid for App Engine Flexible environment deployments.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). # 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.
402 "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
403 "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
404 "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800405 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
406 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700407 "defaultExpiration": "A String", # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700408 "basicScaling": { # 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. # 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.
409 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
410 "maxInstances": 42, # Maximum number of instances to create for this version.
411 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700412 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
414 "A String",
415 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400416 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
417 # AutomaticScaling: F1, F2, F4, F4_1G
418 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800419 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700420 { # Custom static error page to be served when an error occurs.
421 "errorCode": "A String", # Error condition this handler applies to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800422 "mimeType": "A String", # MIME type of file. Defaults to text/html.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700423 "staticFile": "A String", # Static file content to be served for this error.
424 },
425 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700426 "id": "A String", # 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-".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700428 "checkInterval": "A String", # Interval between health checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700429 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700430 "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700431 "timeout": "A String", # Time before the check is considered failed.
432 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700433 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
434 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700435 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700436 "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800437 "apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700438 "url": "A String", # URL to serve the endpoint at.
439 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440 "login": "A String", # Level of login required to access this resource. Defaults to optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700441 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700442 "script": "A String", # Path to the script from the application root directory.
443 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700444 "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
445 "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
446 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
447 "A String",
448 ],
449 "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
450 "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
451 "subnetworkName": "A String", # 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.
452 # If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
453 # If the network that the 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.
454 # If the network that the 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 App Engine flexible environment application.
455 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700456 "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700457 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
458 "checkInterval": "A String", # Interval between health checks.
459 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
460 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
461 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
462 "timeout": "A String", # Time before the health check is considered failed.
463 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
464 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700465 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800466 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700467 { # Third-party Python runtime library that is required by the application.
468 "version": "A String", # Version of the library to select, or "latest".
469 "name": "A String", # Name of the library. Example: "django".
470 },
471 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700472 "entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
473 "shell": "A String", # The format should be a shell command that can be fed to bash -c.
474 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800475 "env": "A String", # App Engine execution environment for this version.Defaults to standard.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700477 "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
478 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700479 "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700480 "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
481 "targetSentPacketsPerSecond": 42, # Target packets sent per second.
482 "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
483 "targetSentBytesPerSecond": 42, # Target bytes sent per second.
484 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700485 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
486 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
487 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700488 "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700489 "targetReadOpsPerSecond": 42, # Target ops read per seconds.
490 "targetWriteBytesPerSecond": 42, # Target bytes written per second.
491 "targetReadBytesPerSecond": 42, # Target bytes read per second.
492 "targetWriteOpsPerSecond": 42, # Target ops written per second.
493 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700494 "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700495 "targetConcurrentRequests": 42, # Target number of concurrent requests.
496 "targetRequestCountPerSecond": 42, # Target requests per second.
497 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700498 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
499 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
500 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
501 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700502 "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
503 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800504 "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700505 "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
506 "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
507 "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
508 "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
509 "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
510 "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700511 },
512 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800513 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700514 "a_key": "A String",
515 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700516 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400517 "memoryGb": 3.14, # Memory (GB) needed.
518 "diskGb": 3.14, # Disk size (GB) needed.
519 "cpu": 3.14, # Number of CPU cores needed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800520 "volumes": [ # User specified volumes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700521 { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800522 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
523 "name": "A String", # Unique name for the volume.
524 "sizeGb": 3.14, # Volume size in gigabytes.
525 },
526 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700527 },
528 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800529 "instances": 42, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700530 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700531 "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
532 "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
533 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700534 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
535 "A String",
536 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537 "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400538 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
539 "a_key": "A String",
540 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800541 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
542 "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700543 "files": { # 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.
544 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800545 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700546 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700547 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
548 },
549 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700550 "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
551 "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
552 "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
553 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700554 "container": { # 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. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
555 "image": "A String", # 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"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700556 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700557 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700558 "filesCount": 42, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700559 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700560 },
561 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700562 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700563 "checkInterval": "A String", # Interval between health checks.
564 "initialDelay": "A String", # The initial delay before starting to execute the checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700565 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
566 "timeout": "A String", # Time before the check is considered failed.
567 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700568 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
569 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700570 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400571 "createTime": "A String", # Time that this version was created.@OutputOnly
Dan O'Mearadd494642020-05-01 07:42:23 -0700572 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
573 "runtimeApiVersion": "A String", # 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/&lt;language&gt;/config/appref
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400574 "nobuildFilesRegex": "A String", # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800575 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
576 "handlers": [ # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700577 { # 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.
578 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800579 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700580 "urlRegex": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700581 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700582 "scriptPath": "A String", # Path to the script from the application root directory.
583 },
584 "staticFiles": { # 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. # Returns the contents of a file, such as an image, as the response.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800585 "mimeType": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700586 "applicationReadable": True or False, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700587 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
588 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
589 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
590 "path": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700591 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
592 "a_key": "A String",
593 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700594 },
595 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
596 "scriptPath": "A String", # Path to the script from the application root directory.
597 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700598 "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700599 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700600 },
601 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800602 "servingStatus": "A String", # 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.
603 "runtime": "A String", # Desired runtime. Example: python27.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700604 }</pre>
605</div>
606
607<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700608 <code class="details" id="list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700609 <pre>Lists the versions of a service.
610
611Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800612 appsId: string, Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700613 servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
614 pageSize: integer, Maximum results to return per page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700615 pageToken: string, Continuation token for fetching the next page of results.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700616 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400617 Allowed values
618 1 - v1 error format
619 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800620 view: string, Controls the set of fields returned in the List response.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700621
622Returns:
623 An object of the form:
624
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800625 { # Response message for Versions.ListVersions.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700626 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
627 "versions": [ # The versions belonging to the requested service.
628 { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700629 "endpointsApiService": { # 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. Only valid for App Engine Flexible environment deployments.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). # 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.
630 "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
631 "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
632 "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800633 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
634 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700635 "defaultExpiration": "A String", # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700636 "basicScaling": { # 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. # 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.
637 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
638 "maxInstances": 42, # Maximum number of instances to create for this version.
639 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700640 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700641 "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
642 "A String",
643 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400644 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
645 # AutomaticScaling: F1, F2, F4, F4_1G
646 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800647 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700648 { # Custom static error page to be served when an error occurs.
649 "errorCode": "A String", # Error condition this handler applies to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800650 "mimeType": "A String", # MIME type of file. Defaults to text/html.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700651 "staticFile": "A String", # Static file content to be served for this error.
652 },
653 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700654 "id": "A String", # 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-".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700655 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700656 "checkInterval": "A String", # Interval between health checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700657 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700658 "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700659 "timeout": "A String", # Time before the check is considered failed.
660 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700661 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
662 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700663 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700664 "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800665 "apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700666 "url": "A String", # URL to serve the endpoint at.
667 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700668 "login": "A String", # Level of login required to access this resource. Defaults to optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700669 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700670 "script": "A String", # Path to the script from the application root directory.
671 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700672 "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
673 "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
674 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
675 "A String",
676 ],
677 "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
678 "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
679 "subnetworkName": "A String", # 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.
680 # If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
681 # If the network that the 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.
682 # If the network that the 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 App Engine flexible environment application.
683 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700684 "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700685 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
686 "checkInterval": "A String", # Interval between health checks.
687 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
688 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
689 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
690 "timeout": "A String", # Time before the health check is considered failed.
691 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
692 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700693 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800694 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700695 { # Third-party Python runtime library that is required by the application.
696 "version": "A String", # Version of the library to select, or "latest".
697 "name": "A String", # Name of the library. Example: "django".
698 },
699 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700700 "entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
701 "shell": "A String", # The format should be a shell command that can be fed to bash -c.
702 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800703 "env": "A String", # App Engine execution environment for this version.Defaults to standard.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700704 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700705 "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
706 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700707 "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700708 "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
709 "targetSentPacketsPerSecond": 42, # Target packets sent per second.
710 "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
711 "targetSentBytesPerSecond": 42, # Target bytes sent per second.
712 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700713 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
714 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
715 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700717 "targetReadOpsPerSecond": 42, # Target ops read per seconds.
718 "targetWriteBytesPerSecond": 42, # Target bytes written per second.
719 "targetReadBytesPerSecond": 42, # Target bytes read per second.
720 "targetWriteOpsPerSecond": 42, # Target ops written per second.
721 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700722 "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700723 "targetConcurrentRequests": 42, # Target number of concurrent requests.
724 "targetRequestCountPerSecond": 42, # Target requests per second.
725 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700726 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
727 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
728 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
729 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700730 "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
731 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800732 "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700733 "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
734 "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
735 "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
736 "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
737 "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
738 "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700739 },
740 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800741 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700742 "a_key": "A String",
743 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400745 "memoryGb": 3.14, # Memory (GB) needed.
746 "diskGb": 3.14, # Disk size (GB) needed.
747 "cpu": 3.14, # Number of CPU cores needed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800748 "volumes": [ # User specified volumes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700749 { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800750 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
751 "name": "A String", # Unique name for the volume.
752 "sizeGb": 3.14, # Volume size in gigabytes.
753 },
754 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700755 },
756 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800757 "instances": 42, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700758 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700759 "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
760 "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
761 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700762 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
763 "A String",
764 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700765 "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400766 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
767 "a_key": "A String",
768 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800769 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
770 "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700771 "files": { # 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.
772 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800773 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700774 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700775 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
776 },
777 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700778 "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
779 "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
780 "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
781 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700782 "container": { # 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. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
783 "image": "A String", # 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"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700784 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700785 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700786 "filesCount": 42, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700787 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700788 },
789 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700790 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700791 "checkInterval": "A String", # Interval between health checks.
792 "initialDelay": "A String", # The initial delay before starting to execute the checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700793 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
794 "timeout": "A String", # Time before the check is considered failed.
795 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700796 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
797 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700798 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400799 "createTime": "A String", # Time that this version was created.@OutputOnly
Dan O'Mearadd494642020-05-01 07:42:23 -0700800 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
801 "runtimeApiVersion": "A String", # 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/&lt;language&gt;/config/appref
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400802 "nobuildFilesRegex": "A String", # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800803 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
804 "handlers": [ # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700805 { # 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.
806 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800807 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700808 "urlRegex": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700809 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700810 "scriptPath": "A String", # Path to the script from the application root directory.
811 },
812 "staticFiles": { # 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. # Returns the contents of a file, such as an image, as the response.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800813 "mimeType": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700814 "applicationReadable": True or False, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700815 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
816 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
817 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
818 "path": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700819 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
820 "a_key": "A String",
821 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700822 },
823 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
824 "scriptPath": "A String", # Path to the script from the application root directory.
825 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700826 "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700827 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700828 },
829 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800830 "servingStatus": "A String", # 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.
831 "runtime": "A String", # Desired runtime. Example: python27.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700832 },
833 ],
834 }</pre>
835</div>
836
837<div class="method">
838 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
839 <pre>Retrieves the next page of results.
840
841Args:
842 previous_request: The request for the previous page. (required)
843 previous_response: The response from the request for the previous page. (required)
844
845Returns:
846 A request object that you can call 'execute()' on to request the next
847 page. Returns None if there are no more items in the collection.
848 </pre>
849</div>
850
851<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700852 <code class="details" id="patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700853 <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment
854instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment:
855automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
856automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
857automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
858automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
859automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
860automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment:
861serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible environment
862serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment:
863automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
864automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
865automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
866automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700867
868Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800869 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700870 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
871 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700872 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700873 The object takes the form of:
874
875{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700876 "endpointsApiService": { # 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. Only valid for App Engine Flexible environment deployments.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). # 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.
877 "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
878 "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
879 "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800880 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
881 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700882 "defaultExpiration": "A String", # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700883 "basicScaling": { # 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. # 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.
884 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
885 "maxInstances": 42, # Maximum number of instances to create for this version.
886 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700887 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700888 "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
889 "A String",
890 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400891 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
892 # AutomaticScaling: F1, F2, F4, F4_1G
893 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800894 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700895 { # Custom static error page to be served when an error occurs.
896 "errorCode": "A String", # Error condition this handler applies to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800897 "mimeType": "A String", # MIME type of file. Defaults to text/html.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700898 "staticFile": "A String", # Static file content to be served for this error.
899 },
900 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700901 "id": "A String", # 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-".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700902 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700903 "checkInterval": "A String", # Interval between health checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700904 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700905 "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700906 "timeout": "A String", # Time before the check is considered failed.
907 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -0700908 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
909 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700910 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700911 "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800912 "apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700913 "url": "A String", # URL to serve the endpoint at.
914 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700915 "login": "A String", # Level of login required to access this resource. Defaults to optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700916 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700917 "script": "A String", # Path to the script from the application root directory.
918 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700919 "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
920 "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
921 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
922 "A String",
923 ],
924 "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
925 "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
926 "subnetworkName": "A String", # 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.
927 # If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
928 # If the network that the 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.
929 # If the network that the 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 App Engine flexible environment application.
930 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700931 "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700932 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
933 "checkInterval": "A String", # Interval between health checks.
934 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
935 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
936 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
937 "timeout": "A String", # Time before the health check is considered failed.
938 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
939 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700940 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800941 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700942 { # Third-party Python runtime library that is required by the application.
943 "version": "A String", # Version of the library to select, or "latest".
944 "name": "A String", # Name of the library. Example: "django".
945 },
946 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700947 "entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
948 "shell": "A String", # The format should be a shell command that can be fed to bash -c.
949 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800950 "env": "A String", # App Engine execution environment for this version.Defaults to standard.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700951 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700952 "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
953 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700954 "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700955 "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
956 "targetSentPacketsPerSecond": 42, # Target packets sent per second.
957 "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
958 "targetSentBytesPerSecond": 42, # Target bytes sent per second.
959 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700960 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
961 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
962 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700963 "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700964 "targetReadOpsPerSecond": 42, # Target ops read per seconds.
965 "targetWriteBytesPerSecond": 42, # Target bytes written per second.
966 "targetReadBytesPerSecond": 42, # Target bytes read per second.
967 "targetWriteOpsPerSecond": 42, # Target ops written per second.
968 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700969 "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700970 "targetConcurrentRequests": 42, # Target number of concurrent requests.
971 "targetRequestCountPerSecond": 42, # Target requests per second.
972 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700973 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
974 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
975 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
976 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700977 "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
978 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800979 "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700980 "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
981 "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
982 "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
983 "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
984 "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
985 "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700986 },
987 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800988 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700989 "a_key": "A String",
990 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700991 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400992 "memoryGb": 3.14, # Memory (GB) needed.
993 "diskGb": 3.14, # Disk size (GB) needed.
994 "cpu": 3.14, # Number of CPU cores needed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800995 "volumes": [ # User specified volumes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700996 { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800997 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
998 "name": "A String", # Unique name for the volume.
999 "sizeGb": 3.14, # Volume size in gigabytes.
1000 },
1001 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001002 },
1003 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001004 "instances": 42, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001005 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001006 "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
1007 "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
1008 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001009 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
1010 "A String",
1011 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001012 "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001013 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
1014 "a_key": "A String",
1015 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001016 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
1017 "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001018 "files": { # 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.
1019 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001020 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
Dan O'Mearadd494642020-05-01 07:42:23 -07001021 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001022 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
1023 },
1024 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001025 "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
1026 "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
1027 "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
1028 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001029 "container": { # 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. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
1030 "image": "A String", # 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"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001031 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -07001032 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001033 "filesCount": 42, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001034 "sourceUrl": "A String", # 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/&lt;bucket&gt;/&lt;object&gt;'.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001035 },
1036 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001037 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001038 "checkInterval": "A String", # Interval between health checks.
1039 "initialDelay": "A String", # The initial delay before starting to execute the checks.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001040 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
1041 "timeout": "A String", # Time before the check is considered failed.
1042 "path": "A String", # The request path.
Thomas Coffee2f245372017-03-27 10:39:26 -07001043 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
1044 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001045 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001046 "createTime": "A String", # Time that this version was created.@OutputOnly
Dan O'Mearadd494642020-05-01 07:42:23 -07001047 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
1048 "runtimeApiVersion": "A String", # 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/&lt;language&gt;/config/appref
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001049 "nobuildFilesRegex": "A String", # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001050 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
1051 "handlers": [ # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001052 { # 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.
1053 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001054 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001055 "urlRegex": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001056 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001057 "scriptPath": "A String", # Path to the script from the application root directory.
1058 },
1059 "staticFiles": { # 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. # Returns the contents of a file, such as an image, as the response.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001060 "mimeType": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001061 "applicationReadable": True or False, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001062 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
1063 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
1064 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
1065 "path": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001066 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
1067 "a_key": "A String",
1068 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001069 },
1070 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
1071 "scriptPath": "A String", # Path to the script from the application root directory.
1072 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001073 "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
Dan O'Mearadd494642020-05-01 07:42:23 -07001074 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001075 },
1076 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001077 "servingStatus": "A String", # 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.
1078 "runtime": "A String", # Desired runtime. Example: python27.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001079 }
1080
1081 updateMask: string, Standard field mask for the set of fields to be updated.
1082 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001083 Allowed values
1084 1 - v1 error format
1085 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001086
1087Returns:
1088 An object of the form:
1089
1090 { # This resource represents a long-running operation that is the result of a network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -07001091 "response": { # 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.
1092 "a_key": "", # Properties of the object. Contains field @type with type URL.
1093 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001094 "metadata": { # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001095 "a_key": "", # Properties of the object. Contains field @type with type URL.
1096 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001097 "done": True or False, # 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.
1098 "name": "A String", # 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 be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001099 "error": { # 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001100 "message": "A String", # 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.
1101 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001102 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001103 {
1104 "a_key": "", # Properties of the object. Contains field @type with type URL.
1105 },
1106 ],
1107 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001108 }</pre>
1109</div>
1110
1111</body></html>