Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / appengine_v1beta4.apps.modules.versions.html
blob: 223561dfa95473c85098224b4c63148d444fb89c [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<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
75<h1><a href="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a> . <a href="appengine_v1beta4.apps.modules.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]78 <code><a href="appengine_v1beta4.apps.modules.versions.instances.html">instances()</a></code>
79</p>
80<p class="firstline">Returns the instances Resource.</p>
81
82<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83 <code><a href="#create">create(appsId, modulesId, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]84<p class="firstline">Deploys code and resource files to a new version.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#delete">delete(appsId, modulesId, versionsId, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes an existing version.</p>
88<p class="toc_element">
89 <code><a href="#get">get(appsId, modulesId, versionsId, x__xgafv=None, view=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]90<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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#list">list(appsId, modulesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
93<p class="firstline">Lists the versions of a module.</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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]97<p class="toc_element">
98 <code><a href="#patch">patch(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None)</a></code></p>
99<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: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="create">create(appsId, modulesId, body, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]103 <pre>Deploys code and resource files to a new version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104
105Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]106 appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
108 body: object, The request body. (required)
109 The object takes the form of:
110
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]111{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 "basicScaling": { # A module 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 module 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]113 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
114 "maxInstances": 42, # Maximum number of instances to create for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]116 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]117 "a_key": "A String",
118 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]119 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
120 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
121 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
122 { # Custom static error page to be served when an error occurs.
123 "errorCode": "A String", # Error condition this handler applies to.
124 "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 "staticFile": "A String", # Static file content to be served for this error.
126 },
127 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]128 "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
129 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]130 "url": "A String", # URL to serve the endpoint at.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]131 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
132 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
133 "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
134 "script": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]135 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]136 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
137 "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 VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
138 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
139 "checkInterval": "A String", # Interval between health checks.
140 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
141 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
142 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
143 "timeout": "A String", # Time before the health check is considered failed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]144 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
145 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]146 "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.
147 "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
148 { # Third-party Python runtime library that is required by the application.
149 "version": "A String", # Version of the library to select, or "latest".
150 "name": "A String", # Name of the library. Example: "django".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]151 },
152 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]153 "deployer": "A String", # Email address of the user who created this version. @OutputOnly
154 "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
155 "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.
156 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
157 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
158 "targetReceivedBytesPerSec": 42, # Target bytes received per second.
159 "targetSentBytesPerSec": 42, # Target bytes sent per second.
160 "targetReceivedPacketsPerSec": 42, # Target packets received per second.
161 "targetSentPacketsPerSec": 42, # Target packets sent per second.
162 },
163 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
164 "targetWriteOpsPerSec": 42, # Target ops written per second.
165 "targetReadBytesPerSec": 42, # Target bytes read per second.
166 "targetReadOpsPerSec": 42, # Target ops read per second.
167 "targetWriteBytesPerSec": 42, # Target bytes written per second.
168 },
169 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
170 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
171 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
172 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
173 "targetConcurrentRequests": 42, # Target number of concurrent requests.
174 "targetRequestCountPerSec": 42, # Target requests per second.
175 },
176 "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
177 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
178 "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.
179 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]181 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
182 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]183 },
184 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]185 "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186 "a_key": "A String",
187 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]188 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
189 "diskGb": 3.14, # Disk size (GB) needed.
190 "cpu": 3.14, # Number of CPU cores needed.
191 "memoryGb": 3.14, # Memory (GB) needed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192 },
193 "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]194 "instances": 42, # Number of instances to assign to the module 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 },
196 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
197 "A String",
198 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]199 "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.
200 "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.
201 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
202 "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
203 "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/\/\'.
204 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205 },
206 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]207 "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
208 { # Reference to a particular snapshot of the source tree used to build and deploy the application.
209 "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
210 "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]211 },
212 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]213 "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
214 "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]215 },
216 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]217 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
218 "instanceTag": "A String", # Tag to apply to the VM instance during creation.
219 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]220 "A String",
221 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]222 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]223 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]224 "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.
225 "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
226 "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.
227 { # 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]228 "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]229 "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
231 "a_key": "A String",
232 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]233 "expiration": "A String", # Time a static file served by this handler should be cached.
234 "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
235 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
236 "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]237 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]238 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
239 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
240 "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
241 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
242 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]243 },
244 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]245 "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.
246 "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.
247 "expiration": "A String", # Time a static file served by this handler should be cached.
248 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
249 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
250 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
252 "a_key": "A String",
253 },
254 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]255 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
256 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]257 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]258 "login": "A String", # Level of login required to access this resource.
259 "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260 },
261 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]262 "creationTime": "A String", # Time that this version was created. @OutputOnly
263 "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`.
264 "runtime": "A String", # Desired runtime. Example: `python27`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]265 }
266
267 x__xgafv: string, V1 error format.
268
269Returns:
270 An object of the form:
271
272 { # This resource represents a long-running operation that is the result of a network API call.
273 "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`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]274 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]275 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]276 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
277 "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.
278 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]279 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
280 {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]281 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]282 },
283 ],
284 },
285 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]286 "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 have the format of `operations/some/unique/name`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]287 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]288 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]289 },
290 }</pre>
291</div>
292
293<div class="method">
294 <code class="details" id="delete">delete(appsId, modulesId, versionsId, x__xgafv=None)</code>
295 <pre>Deletes an existing version.
296
297Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]298 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]299 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
300 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
301 x__xgafv: string, V1 error format.
302
303Returns:
304 An object of the form:
305
306 { # This resource represents a long-running operation that is the result of a network API call.
307 "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`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]308 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]309 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]310 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
311 "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.
312 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]313 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
314 {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]315 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 },
317 ],
318 },
319 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]320 "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 have the format of `operations/some/unique/name`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]321 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]322 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323 },
324 }</pre>
325</div>
326
327<div class="method">
328 <code class="details" id="get">get(appsId, modulesId, versionsId, x__xgafv=None, view=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]329 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]330
331Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]332 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]333 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
334 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
335 x__xgafv: string, V1 error format.
336 view: string, Controls the set of fields returned in the `Get` response.
337
338Returns:
339 An object of the form:
340
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]341 { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]342 "basicScaling": { # A module 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 module 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]343 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
344 "maxInstances": 42, # Maximum number of instances to create for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]345 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]346 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]347 "a_key": "A String",
348 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]349 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
350 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
351 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
352 { # Custom static error page to be served when an error occurs.
353 "errorCode": "A String", # Error condition this handler applies to.
354 "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]355 "staticFile": "A String", # Static file content to be served for this error.
356 },
357 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]358 "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
359 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]360 "url": "A String", # URL to serve the endpoint at.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]361 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
362 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
363 "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
364 "script": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]365 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]366 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
367 "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 VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
368 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
369 "checkInterval": "A String", # Interval between health checks.
370 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
371 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
372 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
373 "timeout": "A String", # Time before the health check is considered failed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]374 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
375 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]376 "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.
377 "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
378 { # Third-party Python runtime library that is required by the application.
379 "version": "A String", # Version of the library to select, or "latest".
380 "name": "A String", # Name of the library. Example: "django".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]381 },
382 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]383 "deployer": "A String", # Email address of the user who created this version. @OutputOnly
384 "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
385 "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.
386 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
387 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
388 "targetReceivedBytesPerSec": 42, # Target bytes received per second.
389 "targetSentBytesPerSec": 42, # Target bytes sent per second.
390 "targetReceivedPacketsPerSec": 42, # Target packets received per second.
391 "targetSentPacketsPerSec": 42, # Target packets sent per second.
392 },
393 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
394 "targetWriteOpsPerSec": 42, # Target ops written per second.
395 "targetReadBytesPerSec": 42, # Target bytes read per second.
396 "targetReadOpsPerSec": 42, # Target ops read per second.
397 "targetWriteBytesPerSec": 42, # Target bytes written per second.
398 },
399 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
400 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
401 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
402 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
403 "targetConcurrentRequests": 42, # Target number of concurrent requests.
404 "targetRequestCountPerSec": 42, # Target requests per second.
405 },
406 "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
407 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
408 "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.
409 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]410 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]411 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
412 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]413 },
414 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]415 "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]416 "a_key": "A String",
417 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]418 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
419 "diskGb": 3.14, # Disk size (GB) needed.
420 "cpu": 3.14, # Number of CPU cores needed.
421 "memoryGb": 3.14, # Memory (GB) needed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]422 },
423 "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]424 "instances": 42, # Number of instances to assign to the module 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]425 },
426 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
427 "A String",
428 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]429 "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.
430 "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.
431 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
432 "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
433 "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/\/\'.
434 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]435 },
436 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]437 "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
438 { # Reference to a particular snapshot of the source tree used to build and deploy the application.
439 "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
440 "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]441 },
442 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]443 "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
444 "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]445 },
446 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]447 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
448 "instanceTag": "A String", # Tag to apply to the VM instance during creation.
449 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]450 "A String",
451 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]452 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]453 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]454 "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.
455 "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
456 "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.
457 { # 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]458 "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]459 "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]460 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
461 "a_key": "A String",
462 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]463 "expiration": "A String", # Time a static file served by this handler should be cached.
464 "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
465 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
466 "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]467 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]468 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
469 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
470 "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
471 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
472 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]473 },
474 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]475 "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.
476 "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.
477 "expiration": "A String", # Time a static file served by this handler should be cached.
478 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
479 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
480 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]481 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
482 "a_key": "A String",
483 },
484 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]485 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
486 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]487 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]488 "login": "A String", # Level of login required to access this resource.
489 "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]490 },
491 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]492 "creationTime": "A String", # Time that this version was created. @OutputOnly
493 "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`.
494 "runtime": "A String", # Desired runtime. Example: `python27`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]495 }</pre>
496</div>
497
498<div class="method">
499 <code class="details" id="list">list(appsId, modulesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
500 <pre>Lists the versions of a module.
501
502Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]503 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]504 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
505 pageSize: integer, Maximum results to return per page.
506 pageToken: string, Continuation token for fetching the next page of results.
507 x__xgafv: string, V1 error format.
508 view: string, Controls the set of fields returned in the `List` response.
509
510Returns:
511 An object of the form:
512
513 { # Response message for `Versions.ListVersions`.
514 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]515 "versions": [ # The versions belonging to the requested module.
516 { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]517 "basicScaling": { # A module 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 module 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]518 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
519 "maxInstances": 42, # Maximum number of instances to create for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]520 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]521 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]522 "a_key": "A String",
523 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]524 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
525 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
526 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
527 { # Custom static error page to be served when an error occurs.
528 "errorCode": "A String", # Error condition this handler applies to.
529 "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]530 "staticFile": "A String", # Static file content to be served for this error.
531 },
532 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]533 "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
534 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]535 "url": "A String", # URL to serve the endpoint at.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]536 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
537 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
538 "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
539 "script": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]540 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]541 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
542 "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 VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
543 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
544 "checkInterval": "A String", # Interval between health checks.
545 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
546 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
547 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
548 "timeout": "A String", # Time before the health check is considered failed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]549 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
550 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]551 "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.
552 "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
553 { # Third-party Python runtime library that is required by the application.
554 "version": "A String", # Version of the library to select, or "latest".
555 "name": "A String", # Name of the library. Example: "django".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]556 },
557 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]558 "deployer": "A String", # Email address of the user who created this version. @OutputOnly
559 "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
560 "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.
561 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
562 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
563 "targetReceivedBytesPerSec": 42, # Target bytes received per second.
564 "targetSentBytesPerSec": 42, # Target bytes sent per second.
565 "targetReceivedPacketsPerSec": 42, # Target packets received per second.
566 "targetSentPacketsPerSec": 42, # Target packets sent per second.
567 },
568 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
569 "targetWriteOpsPerSec": 42, # Target ops written per second.
570 "targetReadBytesPerSec": 42, # Target bytes read per second.
571 "targetReadOpsPerSec": 42, # Target ops read per second.
572 "targetWriteBytesPerSec": 42, # Target bytes written per second.
573 },
574 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
575 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
576 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
577 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
578 "targetConcurrentRequests": 42, # Target number of concurrent requests.
579 "targetRequestCountPerSec": 42, # Target requests per second.
580 },
581 "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
582 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
583 "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.
584 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]585 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]586 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
587 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]588 },
589 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]590 "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]591 "a_key": "A String",
592 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]593 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
594 "diskGb": 3.14, # Disk size (GB) needed.
595 "cpu": 3.14, # Number of CPU cores needed.
596 "memoryGb": 3.14, # Memory (GB) needed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]597 },
598 "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]599 "instances": 42, # Number of instances to assign to the module 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]600 },
601 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
602 "A String",
603 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]604 "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.
605 "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.
606 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
607 "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
608 "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/\/\'.
609 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]610 },
611 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]612 "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
613 { # Reference to a particular snapshot of the source tree used to build and deploy the application.
614 "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
615 "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]616 },
617 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]618 "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
619 "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]620 },
621 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]622 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
623 "instanceTag": "A String", # Tag to apply to the VM instance during creation.
624 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]625 "A String",
626 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]627 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]628 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]629 "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.
630 "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
631 "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.
632 { # 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]633 "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]634 "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]635 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
636 "a_key": "A String",
637 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]638 "expiration": "A String", # Time a static file served by this handler should be cached.
639 "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
640 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
641 "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]642 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]643 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
644 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
645 "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
646 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
647 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]648 },
649 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]650 "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.
651 "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.
652 "expiration": "A String", # Time a static file served by this handler should be cached.
653 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
654 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
655 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]656 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
657 "a_key": "A String",
658 },
659 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]660 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
661 "scriptPath": "A String", # Path to the script from the application root directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]662 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]663 "login": "A String", # Level of login required to access this resource.
664 "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]665 },
666 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]667 "creationTime": "A String", # Time that this version was created. @OutputOnly
668 "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`.
669 "runtime": "A String", # Desired runtime. Example: `python27`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]670 },
671 ],
672 }</pre>
673</div>
674
675<div class="method">
676 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
677 <pre>Retrieves the next page of results.
678
679Args:
680 previous_request: The request for the previous page. (required)
681 previous_response: The response from the request for the previous page. (required)
682
683Returns:
684 A request object that you can call 'execute()' on to request the next
685 page. Returns None if there are no more items in the collection.
686 </pre>
687</div>
688
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]689<div class="method">
690 <code class="details" id="patch">patch(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None)</code>
691 <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: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
692
693Args:
694 appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default/versions/1`. (required)
695 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
696 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
697 body: object, The request body. (required)
698 The object takes the form of:
699
700{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
701 "basicScaling": { # A module 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 module 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.
702 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
703 "maxInstances": 42, # Maximum number of instances to create for this version.
704 },
705 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
706 "a_key": "A String",
707 },
708 "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
709 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
710 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
711 { # Custom static error page to be served when an error occurs.
712 "errorCode": "A String", # Error condition this handler applies to.
713 "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
714 "staticFile": "A String", # Static file content to be served for this error.
715 },
716 ],
717 "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
718 "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.
719 "url": "A String", # URL to serve the endpoint at.
720 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
721 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
722 "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
723 "script": "A String", # Path to the script from the application root directory.
724 },
725 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
726 "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 VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
727 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
728 "checkInterval": "A String", # Interval between health checks.
729 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
730 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
731 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
732 "timeout": "A String", # Time before the health check is considered failed.
733 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
734 },
735 "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.
736 "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
737 { # Third-party Python runtime library that is required by the application.
738 "version": "A String", # Version of the library to select, or "latest".
739 "name": "A String", # Name of the library. Example: "django".
740 },
741 ],
742 "deployer": "A String", # Email address of the user who created this version. @OutputOnly
743 "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
744 "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.
745 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
746 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
747 "targetReceivedBytesPerSec": 42, # Target bytes received per second.
748 "targetSentBytesPerSec": 42, # Target bytes sent per second.
749 "targetReceivedPacketsPerSec": 42, # Target packets received per second.
750 "targetSentPacketsPerSec": 42, # Target packets sent per second.
751 },
752 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
753 "targetWriteOpsPerSec": 42, # Target ops written per second.
754 "targetReadBytesPerSec": 42, # Target bytes read per second.
755 "targetReadOpsPerSec": 42, # Target ops read per second.
756 "targetWriteBytesPerSec": 42, # Target bytes written per second.
757 },
758 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
759 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
760 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
761 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
762 "targetConcurrentRequests": 42, # Target number of concurrent requests.
763 "targetRequestCountPerSec": 42, # Target requests per second.
764 },
765 "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
766 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
767 "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.
768 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
769 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
770 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
771 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
772 },
773 },
774 "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
775 "a_key": "A String",
776 },
777 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
778 "diskGb": 3.14, # Disk size (GB) needed.
779 "cpu": 3.14, # Number of CPU cores needed.
780 "memoryGb": 3.14, # Memory (GB) needed.
781 },
782 "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
783 "instances": 42, # Number of instances to assign to the module 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.
784 },
785 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
786 "A String",
787 ],
788 "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.
789 "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.
790 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
791 "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
792 "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/\/\'.
793 "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
794 },
795 },
796 "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
797 { # Reference to a particular snapshot of the source tree used to build and deploy the application.
798 "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
799 "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
800 },
801 ],
802 "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
803 "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
804 },
805 },
806 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
807 "instanceTag": "A String", # Tag to apply to the VM instance during creation.
808 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
809 "A String",
810 ],
811 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
812 },
813 "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.
814 "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
815 "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.
816 { # 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.
817 "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
818 "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
819 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
820 "a_key": "A String",
821 },
822 "expiration": "A String", # Time a static file served by this handler should be cached.
823 "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
824 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
825 "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory 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.
826 },
827 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
828 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
829 "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
830 "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
831 "scriptPath": "A String", # Path to the script from the application root directory.
832 },
833 "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.
834 "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.
835 "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.
836 "expiration": "A String", # Time a static file served by this handler should be cached.
837 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
838 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
839 "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.
840 "httpHeaders": { # HTTP headers to use for all responses from these URLs.
841 "a_key": "A String",
842 },
843 },
844 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
845 "scriptPath": "A String", # Path to the script from the application root directory.
846 },
847 "login": "A String", # Level of login required to access this resource.
848 "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
849 },
850 ],
851 "creationTime": "A String", # Time that this version was created. @OutputOnly
852 "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`.
853 "runtime": "A String", # Desired runtime. Example: `python27`.
854 }
855
856 mask: string, Standard field mask for the set of fields to be updated.
857 x__xgafv: string, V1 error format.
858
859Returns:
860 An object of the form:
861
862 { # This resource represents a long-running operation that is the result of a network API call.
863 "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`.
864 "a_key": "", # Properties of the object. Contains field @type with type URL.
865 },
866 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
867 "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.
868 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
869 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
870 {
871 "a_key": "", # Properties of the object. Contains field @type with type URL.
872 },
873 ],
874 },
875 "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.
876 "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 have the format of `operations/some/unique/name`.
877 "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.
878 "a_key": "", # Properties of the object. Contains field @type with type URL.
879 },
880 }</pre>
881</div>
882
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]883</body></html>