1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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_v1.html">Google App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a> . <a href="appengine_v1.apps.services.versions.html">versions</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="appengine_v1.apps.services.versions.instances.html">instances()</a></code> 79 </p> 80 <p class="firstline">Returns the instances Resource.</p> 81 82 <p class="toc_element"> 83 <code><a href="#create">create(appsId, servicesId, body, x__xgafv=None)</a></code></p> 84 <p class="firstline">Deploys code and resource files to a new version.</p> 85 <p class="toc_element"> 86 <code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p> 87 <p class="firstline">Deletes an existing Version resource.</p> 88 <p class="toc_element"> 89 <code><a href="#get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</a></code></p> 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> 91 <p class="toc_element"> 92 <code><a href="#list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</a></code></p> 93 <p class="firstline">Lists the versions of a service.</p> 94 <p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96 <p class="firstline">Retrieves the next page of results.</p> 97 <p class="toc_element"> 98 <code><a href="#patch">patch(appsId, servicesId, versionsId, body, updateMask=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:</p> 100 <h3>Method Details</h3> 101 <div class="method"> 102 <code class="details" id="create">create(appsId, servicesId, body, x__xgafv=None)</code> 103 <pre>Deploys code and resource files to a new version. 104 105 Args: 106 appsId: string, Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. (required) 107 servicesId: string, Part of `parent`. See documentation of `appsId`. (required) 108 body: object, The request body. (required) 109 The object takes the form of: 110 111 { # A Version resource is a specific set of source code and configuration files that are deployed into a service. 112 "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. 113 "configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1" 114 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" 115 }, 116 "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. 117 "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. 118 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. 119 "maxInstances": 42, # Maximum number of instances to create for this version. 120 }, 121 "vm": True or False, # Whether to deploy this version in a container on a virtual machine. 122 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: 123 # AutomaticScaling: F1, F2, F4, F4_1G 124 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. 125 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. 126 { # Custom static error page to be served when an error occurs. 127 "errorCode": "A String", # Error condition this handler applies to. 128 "mimeType": "A String", # MIME type of file. Defaults to text/html. 129 "staticFile": "A String", # Static file content to be served for this error. 130 }, 131 ], 132 "id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". 133 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. 134 "checkInterval": "A String", # Interval between health checks. 135 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" 136 "timeout": "A String", # Time before the check is considered failed. 137 "path": "A String", # The request path. 138 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. 139 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. 140 }, 141 "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. 142 "url": "A String", # URL to serve the endpoint at. 143 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 144 "login": "A String", # Level of login required to access this resource. Defaults to optional. 145 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 146 "script": "A String", # Path to the script from the application root directory. 147 }, 148 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes. 149 "instanceTag": "A String", # Tag to apply to the VM instance during creation. 150 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. 151 "A String", 152 ], 153 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. 154 "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. 155 # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. 156 # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. 157 # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app. 158 }, 159 "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. 160 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. 161 "checkInterval": "A String", # Interval between health checks. 162 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. 163 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. 164 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" 165 "timeout": "A String", # Time before the health check is considered failed. 166 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. 167 }, 168 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly 169 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. 170 { # Third-party Python runtime library that is required by the application. 171 "version": "A String", # Version of the library to select, or "latest". 172 "name": "A String", # Name of the library. Example: "django". 173 }, 174 ], 175 "env": "A String", # App Engine execution environment for this version.Defaults to standard. 176 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly 177 "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. 178 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. 179 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage. 180 "targetReceivedPacketsPerSecond": 42, # Target packets received per second. 181 "targetSentPacketsPerSecond": 42, # Target packets sent per second. 182 "targetReceivedBytesPerSecond": 42, # Target bytes received per second. 183 "targetSentBytesPerSecond": 42, # Target bytes sent per second. 184 }, 185 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. 186 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. 187 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. 188 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage. 189 "targetReadOpsPerSecond": 42, # Target ops read per seconds. 190 "targetWriteBytesPerSecond": 42, # Target bytes written per second. 191 "targetReadBytesPerSecond": 42, # Target bytes read per second. 192 "targetWriteOpsPerSecond": 42, # Target ops written per second. 193 }, 194 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization. 195 "targetConcurrentRequests": 42, # Target number of concurrent requests. 196 "targetRequestCountPerSecond": 42, # Target requests per second. 197 }, 198 "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. 199 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests. 200 "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. 201 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version. 202 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. 203 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. 204 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. 205 }, 206 }, 207 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. 208 "a_key": "A String", 209 }, 210 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes. 211 "memoryGb": 3.14, # Memory (GB) needed. 212 "diskGb": 3.14, # Disk size (GB) needed. 213 "cpu": 3.14, # Number of CPU cores needed. 214 "volumes": [ # User specified volumes. 215 { # Volumes mounted within the app container. Only applicable for VM runtimes. 216 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. 217 "name": "A String", # Unique name for the volume. 218 "sizeGb": 3.14, # Volume size in gigabytes. 219 }, 220 ], 221 }, 222 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. 223 "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. 224 }, 225 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. 226 "A String", 227 ], 228 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. 229 "a_key": "A String", 230 }, 231 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly 232 "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. 233 "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. 234 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. 235 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. 236 "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/<bucket>/<object>'. 237 "sha1Sum": "A String", # The SHA1 hash of the file, in hex. 238 }, 239 }, 240 "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. 241 "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" 242 }, 243 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. 244 "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. 245 "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. 246 }, 247 }, 248 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. 249 "checkInterval": "A String", # Interval between health checks. 250 "initialDelay": "A String", # The initial delay before starting to execute the checks. 251 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" 252 "timeout": "A String", # Time before the check is considered failed. 253 "path": "A String", # The request path. 254 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. 255 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. 256 }, 257 "createTime": "A String", # Time that this version was created.@OutputOnly 258 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. 259 "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref 260 "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. 261 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly 262 "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. 263 { # 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. 264 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 265 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 266 "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. 267 "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. 268 "scriptPath": "A String", # Path to the script from the application root directory. 269 }, 270 "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. 271 "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. 272 "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. 273 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. 274 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. 275 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. 276 "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. 277 "httpHeaders": { # HTTP headers to use for all responses from these URLs. 278 "a_key": "A String", 279 }, 280 }, 281 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. 282 "scriptPath": "A String", # Path to the script from the application root directory. 283 }, 284 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. 285 "login": "A String", # Level of login required to access this resource. 286 }, 287 ], 288 "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. 289 "runtime": "A String", # Desired runtime. Example: python27. 290 } 291 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297 Returns: 298 An object of the form: 299 300 { # This resource represents a long-running operation that is the result of a network API call. 301 "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. 302 "a_key": "", # Properties of the object. Contains field @type with type URL. 303 }, 304 "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: # The error result of the operation in case of failure or cancellation. 305 # Simple to use and understand for most users 306 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 307 # 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. 308 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 309 # 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. 310 # 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. 311 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 312 "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. 313 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 314 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. 315 { 316 "a_key": "", # Properties of the object. Contains field @type with type URL. 317 }, 318 ], 319 }, 320 "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. 321 "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. 322 "a_key": "", # Properties of the object. Contains field @type with type URL. 323 }, 324 "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. 325 }</pre> 326 </div> 327 328 <div class="method"> 329 <code class="details" id="delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</code> 330 <pre>Deletes an existing Version resource. 331 332 Args: 333 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required) 334 servicesId: string, Part of `name`. See documentation of `appsId`. (required) 335 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 336 x__xgafv: string, V1 error format. 337 Allowed values 338 1 - v1 error format 339 2 - v2 error format 340 341 Returns: 342 An object of the form: 343 344 { # This resource represents a long-running operation that is the result of a network API call. 345 "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. 346 "a_key": "", # Properties of the object. Contains field @type with type URL. 347 }, 348 "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: # The error result of the operation in case of failure or cancellation. 349 # Simple to use and understand for most users 350 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 351 # 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. 352 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 353 # 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. 354 # 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. 355 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 356 "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. 357 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 358 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. 359 { 360 "a_key": "", # Properties of the object. Contains field @type with type URL. 361 }, 362 ], 363 }, 364 "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. 365 "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. 366 "a_key": "", # Properties of the object. Contains field @type with type URL. 367 }, 368 "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. 369 }</pre> 370 </div> 371 372 <div class="method"> 373 <code class="details" id="get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</code> 374 <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. 375 376 Args: 377 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required) 378 servicesId: string, Part of `name`. See documentation of `appsId`. (required) 379 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 380 x__xgafv: string, V1 error format. 381 Allowed values 382 1 - v1 error format 383 2 - v2 error format 384 view: string, Controls the set of fields returned in the Get response. 385 386 Returns: 387 An object of the form: 388 389 { # A Version resource is a specific set of source code and configuration files that are deployed into a service. 390 "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. 391 "configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1" 392 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" 393 }, 394 "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. 395 "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. 396 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. 397 "maxInstances": 42, # Maximum number of instances to create for this version. 398 }, 399 "vm": True or False, # Whether to deploy this version in a container on a virtual machine. 400 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: 401 # AutomaticScaling: F1, F2, F4, F4_1G 402 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. 403 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. 404 { # Custom static error page to be served when an error occurs. 405 "errorCode": "A String", # Error condition this handler applies to. 406 "mimeType": "A String", # MIME type of file. Defaults to text/html. 407 "staticFile": "A String", # Static file content to be served for this error. 408 }, 409 ], 410 "id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". 411 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. 412 "checkInterval": "A String", # Interval between health checks. 413 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" 414 "timeout": "A String", # Time before the check is considered failed. 415 "path": "A String", # The request path. 416 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. 417 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. 418 }, 419 "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. 420 "url": "A String", # URL to serve the endpoint at. 421 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 422 "login": "A String", # Level of login required to access this resource. Defaults to optional. 423 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 424 "script": "A String", # Path to the script from the application root directory. 425 }, 426 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes. 427 "instanceTag": "A String", # Tag to apply to the VM instance during creation. 428 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. 429 "A String", 430 ], 431 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. 432 "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. 433 # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. 434 # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. 435 # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app. 436 }, 437 "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. 438 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. 439 "checkInterval": "A String", # Interval between health checks. 440 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. 441 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. 442 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" 443 "timeout": "A String", # Time before the health check is considered failed. 444 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. 445 }, 446 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly 447 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. 448 { # Third-party Python runtime library that is required by the application. 449 "version": "A String", # Version of the library to select, or "latest". 450 "name": "A String", # Name of the library. Example: "django". 451 }, 452 ], 453 "env": "A String", # App Engine execution environment for this version.Defaults to standard. 454 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly 455 "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. 456 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. 457 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage. 458 "targetReceivedPacketsPerSecond": 42, # Target packets received per second. 459 "targetSentPacketsPerSecond": 42, # Target packets sent per second. 460 "targetReceivedBytesPerSecond": 42, # Target bytes received per second. 461 "targetSentBytesPerSecond": 42, # Target bytes sent per second. 462 }, 463 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. 464 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. 465 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. 466 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage. 467 "targetReadOpsPerSecond": 42, # Target ops read per seconds. 468 "targetWriteBytesPerSecond": 42, # Target bytes written per second. 469 "targetReadBytesPerSecond": 42, # Target bytes read per second. 470 "targetWriteOpsPerSecond": 42, # Target ops written per second. 471 }, 472 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization. 473 "targetConcurrentRequests": 42, # Target number of concurrent requests. 474 "targetRequestCountPerSecond": 42, # Target requests per second. 475 }, 476 "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. 477 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests. 478 "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. 479 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version. 480 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. 481 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. 482 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. 483 }, 484 }, 485 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. 486 "a_key": "A String", 487 }, 488 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes. 489 "memoryGb": 3.14, # Memory (GB) needed. 490 "diskGb": 3.14, # Disk size (GB) needed. 491 "cpu": 3.14, # Number of CPU cores needed. 492 "volumes": [ # User specified volumes. 493 { # Volumes mounted within the app container. Only applicable for VM runtimes. 494 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. 495 "name": "A String", # Unique name for the volume. 496 "sizeGb": 3.14, # Volume size in gigabytes. 497 }, 498 ], 499 }, 500 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. 501 "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. 502 }, 503 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. 504 "A String", 505 ], 506 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. 507 "a_key": "A String", 508 }, 509 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly 510 "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. 511 "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. 512 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. 513 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. 514 "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/<bucket>/<object>'. 515 "sha1Sum": "A String", # The SHA1 hash of the file, in hex. 516 }, 517 }, 518 "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. 519 "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" 520 }, 521 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. 522 "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. 523 "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. 524 }, 525 }, 526 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. 527 "checkInterval": "A String", # Interval between health checks. 528 "initialDelay": "A String", # The initial delay before starting to execute the checks. 529 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" 530 "timeout": "A String", # Time before the check is considered failed. 531 "path": "A String", # The request path. 532 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. 533 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. 534 }, 535 "createTime": "A String", # Time that this version was created.@OutputOnly 536 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. 537 "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref 538 "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. 539 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly 540 "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. 541 { # 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. 542 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 543 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 544 "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. 545 "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. 546 "scriptPath": "A String", # Path to the script from the application root directory. 547 }, 548 "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. 549 "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. 550 "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. 551 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. 552 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. 553 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. 554 "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. 555 "httpHeaders": { # HTTP headers to use for all responses from these URLs. 556 "a_key": "A String", 557 }, 558 }, 559 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. 560 "scriptPath": "A String", # Path to the script from the application root directory. 561 }, 562 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. 563 "login": "A String", # Level of login required to access this resource. 564 }, 565 ], 566 "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. 567 "runtime": "A String", # Desired runtime. Example: python27. 568 }</pre> 569 </div> 570 571 <div class="method"> 572 <code class="details" id="list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</code> 573 <pre>Lists the versions of a service. 574 575 Args: 576 appsId: string, Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. (required) 577 servicesId: string, Part of `parent`. See documentation of `appsId`. (required) 578 pageSize: integer, Maximum results to return per page. 579 x__xgafv: string, V1 error format. 580 Allowed values 581 1 - v1 error format 582 2 - v2 error format 583 pageToken: string, Continuation token for fetching the next page of results. 584 view: string, Controls the set of fields returned in the List response. 585 586 Returns: 587 An object of the form: 588 589 { # Response message for Versions.ListVersions. 590 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 591 "versions": [ # The versions belonging to the requested service. 592 { # A Version resource is a specific set of source code and configuration files that are deployed into a service. 593 "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. 594 "configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1" 595 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" 596 }, 597 "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. 598 "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. 599 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. 600 "maxInstances": 42, # Maximum number of instances to create for this version. 601 }, 602 "vm": True or False, # Whether to deploy this version in a container on a virtual machine. 603 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: 604 # AutomaticScaling: F1, F2, F4, F4_1G 605 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. 606 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. 607 { # Custom static error page to be served when an error occurs. 608 "errorCode": "A String", # Error condition this handler applies to. 609 "mimeType": "A String", # MIME type of file. Defaults to text/html. 610 "staticFile": "A String", # Static file content to be served for this error. 611 }, 612 ], 613 "id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". 614 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. 615 "checkInterval": "A String", # Interval between health checks. 616 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" 617 "timeout": "A String", # Time before the check is considered failed. 618 "path": "A String", # The request path. 619 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. 620 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. 621 }, 622 "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. 623 "url": "A String", # URL to serve the endpoint at. 624 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 625 "login": "A String", # Level of login required to access this resource. Defaults to optional. 626 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 627 "script": "A String", # Path to the script from the application root directory. 628 }, 629 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes. 630 "instanceTag": "A String", # Tag to apply to the VM instance during creation. 631 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. 632 "A String", 633 ], 634 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. 635 "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. 636 # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. 637 # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. 638 # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app. 639 }, 640 "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. 641 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. 642 "checkInterval": "A String", # Interval between health checks. 643 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. 644 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. 645 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" 646 "timeout": "A String", # Time before the health check is considered failed. 647 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. 648 }, 649 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly 650 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. 651 { # Third-party Python runtime library that is required by the application. 652 "version": "A String", # Version of the library to select, or "latest". 653 "name": "A String", # Name of the library. Example: "django". 654 }, 655 ], 656 "env": "A String", # App Engine execution environment for this version.Defaults to standard. 657 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly 658 "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. 659 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. 660 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage. 661 "targetReceivedPacketsPerSecond": 42, # Target packets received per second. 662 "targetSentPacketsPerSecond": 42, # Target packets sent per second. 663 "targetReceivedBytesPerSecond": 42, # Target bytes received per second. 664 "targetSentBytesPerSecond": 42, # Target bytes sent per second. 665 }, 666 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. 667 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. 668 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. 669 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage. 670 "targetReadOpsPerSecond": 42, # Target ops read per seconds. 671 "targetWriteBytesPerSecond": 42, # Target bytes written per second. 672 "targetReadBytesPerSecond": 42, # Target bytes read per second. 673 "targetWriteOpsPerSecond": 42, # Target ops written per second. 674 }, 675 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization. 676 "targetConcurrentRequests": 42, # Target number of concurrent requests. 677 "targetRequestCountPerSecond": 42, # Target requests per second. 678 }, 679 "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. 680 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests. 681 "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. 682 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version. 683 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. 684 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. 685 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. 686 }, 687 }, 688 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. 689 "a_key": "A String", 690 }, 691 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes. 692 "memoryGb": 3.14, # Memory (GB) needed. 693 "diskGb": 3.14, # Disk size (GB) needed. 694 "cpu": 3.14, # Number of CPU cores needed. 695 "volumes": [ # User specified volumes. 696 { # Volumes mounted within the app container. Only applicable for VM runtimes. 697 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. 698 "name": "A String", # Unique name for the volume. 699 "sizeGb": 3.14, # Volume size in gigabytes. 700 }, 701 ], 702 }, 703 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. 704 "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. 705 }, 706 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. 707 "A String", 708 ], 709 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. 710 "a_key": "A String", 711 }, 712 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly 713 "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. 714 "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. 715 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. 716 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. 717 "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/<bucket>/<object>'. 718 "sha1Sum": "A String", # The SHA1 hash of the file, in hex. 719 }, 720 }, 721 "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. 722 "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" 723 }, 724 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. 725 "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. 726 "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. 727 }, 728 }, 729 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. 730 "checkInterval": "A String", # Interval between health checks. 731 "initialDelay": "A String", # The initial delay before starting to execute the checks. 732 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" 733 "timeout": "A String", # Time before the check is considered failed. 734 "path": "A String", # The request path. 735 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. 736 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. 737 }, 738 "createTime": "A String", # Time that this version was created.@OutputOnly 739 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. 740 "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref 741 "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. 742 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly 743 "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. 744 { # 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. 745 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 746 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 747 "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. 748 "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. 749 "scriptPath": "A String", # Path to the script from the application root directory. 750 }, 751 "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. 752 "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. 753 "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. 754 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. 755 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. 756 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. 757 "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. 758 "httpHeaders": { # HTTP headers to use for all responses from these URLs. 759 "a_key": "A String", 760 }, 761 }, 762 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. 763 "scriptPath": "A String", # Path to the script from the application root directory. 764 }, 765 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. 766 "login": "A String", # Level of login required to access this resource. 767 }, 768 ], 769 "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. 770 "runtime": "A String", # Desired runtime. Example: python27. 771 }, 772 ], 773 }</pre> 774 </div> 775 776 <div class="method"> 777 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 778 <pre>Retrieves the next page of results. 779 780 Args: 781 previous_request: The request for the previous page. (required) 782 previous_response: The response from the request for the previous page. (required) 783 784 Returns: 785 A request object that you can call 'execute()' on to request the next 786 page. Returns None if there are no more items in the collection. 787 </pre> 788 </div> 789 790 <div class="method"> 791 <code class="details" id="patch">patch(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)</code> 792 <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: 793 serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. 794 instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. 795 automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. 796 automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. 797 798 Args: 799 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required) 800 servicesId: string, Part of `name`. See documentation of `appsId`. (required) 801 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 802 body: object, The request body. (required) 803 The object takes the form of: 804 805 { # A Version resource is a specific set of source code and configuration files that are deployed into a service. 806 "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. 807 "configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1" 808 "name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" 809 }, 810 "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. 811 "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. 812 "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. 813 "maxInstances": 42, # Maximum number of instances to create for this version. 814 }, 815 "vm": True or False, # Whether to deploy this version in a container on a virtual machine. 816 "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: 817 # AutomaticScaling: F1, F2, F4, F4_1G 818 # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. 819 "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. 820 { # Custom static error page to be served when an error occurs. 821 "errorCode": "A String", # Error condition this handler applies to. 822 "mimeType": "A String", # MIME type of file. Defaults to text/html. 823 "staticFile": "A String", # Static file content to be served for this error. 824 }, 825 ], 826 "id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". 827 "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. 828 "checkInterval": "A String", # Interval between health checks. 829 "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" 830 "timeout": "A String", # Time before the check is considered failed. 831 "path": "A String", # The request path. 832 "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. 833 "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. 834 }, 835 "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. 836 "url": "A String", # URL to serve the endpoint at. 837 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 838 "login": "A String", # Level of login required to access this resource. Defaults to optional. 839 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 840 "script": "A String", # Path to the script from the application root directory. 841 }, 842 "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes. 843 "instanceTag": "A String", # Tag to apply to the VM instance during creation. 844 "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. 845 "A String", 846 ], 847 "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. 848 "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. 849 # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. 850 # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. 851 # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app. 852 }, 853 "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. 854 "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. 855 "checkInterval": "A String", # Interval between health checks. 856 "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. 857 "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. 858 "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" 859 "timeout": "A String", # Time before the health check is considered failed. 860 "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. 861 }, 862 "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly 863 "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. 864 { # Third-party Python runtime library that is required by the application. 865 "version": "A String", # Version of the library to select, or "latest". 866 "name": "A String", # Name of the library. Example: "django". 867 }, 868 ], 869 "env": "A String", # App Engine execution environment for this version.Defaults to standard. 870 "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly 871 "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. 872 "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. 873 "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage. 874 "targetReceivedPacketsPerSecond": 42, # Target packets received per second. 875 "targetSentPacketsPerSecond": 42, # Target packets sent per second. 876 "targetReceivedBytesPerSecond": 42, # Target bytes received per second. 877 "targetSentBytesPerSecond": 42, # Target bytes sent per second. 878 }, 879 "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. 880 "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. 881 "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. 882 "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage. 883 "targetReadOpsPerSecond": 42, # Target ops read per seconds. 884 "targetWriteBytesPerSecond": 42, # Target bytes written per second. 885 "targetReadBytesPerSecond": 42, # Target bytes read per second. 886 "targetWriteOpsPerSecond": 42, # Target ops written per second. 887 }, 888 "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization. 889 "targetConcurrentRequests": 42, # Target number of concurrent requests. 890 "targetRequestCountPerSecond": 42, # Target requests per second. 891 }, 892 "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. 893 "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests. 894 "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. 895 "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version. 896 "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. 897 "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. 898 "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. 899 }, 900 }, 901 "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. 902 "a_key": "A String", 903 }, 904 "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes. 905 "memoryGb": 3.14, # Memory (GB) needed. 906 "diskGb": 3.14, # Disk size (GB) needed. 907 "cpu": 3.14, # Number of CPU cores needed. 908 "volumes": [ # User specified volumes. 909 { # Volumes mounted within the app container. Only applicable for VM runtimes. 910 "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. 911 "name": "A String", # Unique name for the volume. 912 "sizeGb": 3.14, # Volume size in gigabytes. 913 }, 914 ], 915 }, 916 "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. 917 "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. 918 }, 919 "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. 920 "A String", 921 ], 922 "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. 923 "a_key": "A String", 924 }, 925 "createdBy": "A String", # Email address of the user who created this version.@OutputOnly 926 "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. 927 "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. 928 "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. 929 "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. 930 "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/<bucket>/<object>'. 931 "sha1Sum": "A String", # The SHA1 hash of the file, in hex. 932 }, 933 }, 934 "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. 935 "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" 936 }, 937 "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. 938 "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. 939 "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. 940 }, 941 }, 942 "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. 943 "checkInterval": "A String", # Interval between health checks. 944 "initialDelay": "A String", # The initial delay before starting to execute the checks. 945 "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" 946 "timeout": "A String", # Time before the check is considered failed. 947 "path": "A String", # The request path. 948 "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. 949 "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. 950 }, 951 "createTime": "A String", # Time that this version was created.@OutputOnly 952 "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. 953 "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref 954 "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. 955 "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly 956 "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. 957 { # 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. 958 "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. 959 "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. 960 "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. 961 "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. 962 "scriptPath": "A String", # Path to the script from the application root directory. 963 }, 964 "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. 965 "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. 966 "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. 967 "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. 968 "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. 969 "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. 970 "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. 971 "httpHeaders": { # HTTP headers to use for all responses from these URLs. 972 "a_key": "A String", 973 }, 974 }, 975 "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. 976 "scriptPath": "A String", # Path to the script from the application root directory. 977 }, 978 "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. 979 "login": "A String", # Level of login required to access this resource. 980 }, 981 ], 982 "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. 983 "runtime": "A String", # Desired runtime. Example: python27. 984 } 985 986 updateMask: string, Standard field mask for the set of fields to be updated. 987 x__xgafv: string, V1 error format. 988 Allowed values 989 1 - v1 error format 990 2 - v2 error format 991 992 Returns: 993 An object of the form: 994 995 { # This resource represents a long-running operation that is the result of a network API call. 996 "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. 997 "a_key": "", # Properties of the object. Contains field @type with type URL. 998 }, 999 "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: # The error result of the operation in case of failure or cancellation. 1000 # Simple to use and understand for most users 1001 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 1002 # 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. 1003 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 1004 # 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. 1005 # 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. 1006 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 1007 "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. 1008 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1009 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. 1010 { 1011 "a_key": "", # Properties of the object. Contains field @type with type URL. 1012 }, 1013 ], 1014 }, 1015 "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. 1016 "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. 1017 "a_key": "", # Properties of the object. Contains field @type with type URL. 1018 }, 1019 "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. 1020 }</pre> 1021 </div> 1022 1023 </body></html>
