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